VTEX · Schema

SubscriptionCycleResponse

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string
subscriptionId string
status string
customerEmail string
date string
lastUpdate string
cycleCount integer
isInRetry boolean
message string
orderInfo object
context object
simulationItems array
View JSON Schema on GitHub

JSON Schema

vtex-subscriptioncycleresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionCycleResponse",
  "title": "SubscriptionCycleResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "subscriptionId": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "customerEmail": {
      "type": "string",
      "nullable": true
    },
    "date": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdate": {
      "type": "string",
      "format": "date-time"
    },
    "cycleCount": {
      "type": "integer",
      "format": "int32"
    },
    "isInRetry": {
      "type": "boolean"
    },
    "message": {
      "type": "string",
      "nullable": true
    },
    "orderInfo": {
      "$ref": "#/components/schemas/SubscriptionCycleOrderInfo"
    },
    "context": {
      "$ref": "#/components/schemas/SubscriptionCycleContext"
    },
    "simulationItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimulationItemResult"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}