VTEX · Schema

SubscriptionItem

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string
skuId string SKU ID.
quantity integer Amount of units in the cart.
isSkipped boolean
status string
manualPrice integer Manual price.
originalOrderId string
View JSON Schema on GitHub

JSON Schema

vtex-subscriptionitemresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionItemResponse",
  "title": "SubscriptionItem",
  "required": [
    "id",
    "isSkipped",
    "quantity",
    "skuId",
    "status"
  ],
  "type": "object",
  "properties": {
    "id": {
      "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
    },
    "isSkipped": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "manualPrice": {
      "type": "integer",
      "format": "int32",
      "title": "manualPrice",
      "description": "Manual price.",
      "default": null,
      "nullable": true,
      "example": 40
    },
    "originalOrderId": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}