VTEX · Schema

SubscriptionCycleItemContext

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
subscriptionItemId string
skuId string SKU ID.
quantity integer Amount of units in the cart.
status object
isSkipped boolean
cycleCount integer
View JSON Schema on GitHub

JSON Schema

vtex-subscriptioncycleitemcontext-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionCycleItemContext",
  "title": "SubscriptionCycleItemContext",
  "type": "object",
  "properties": {
    "subscriptionItemId": {
      "type": "string",
      "nullable": true
    },
    "skuId": {
      "type": "string",
      "nullable": true,
      "title": "skuId",
      "description": "SKU ID.",
      "example": "12"
    },
    "quantity": {
      "type": "integer",
      "format": "int32",
      "title": "quantity",
      "description": "Amount of units in the cart.",
      "example": 5
    },
    "status": {
      "$ref": "#/components/schemas/Status"
    },
    "isSkipped": {
      "type": "boolean"
    },
    "cycleCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}