VTEX · Schema

Subscription

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string
customerId string
customerEmail string
title string
status string
isSkipped boolean
nextPurchaseDate string
lastPurchaseDate string
plan object
shippingAddress object
purchaseSettings object
cycleCount integer
createdAt string
lastUpdate string
items array
View JSON Schema on GitHub

JSON Schema

vtex-subscriptiongroupresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionGroupResponse",
  "title": "Subscription",
  "required": [
    "createdAt",
    "customerEmail",
    "customerId",
    "cycleCount",
    "id",
    "isSkipped",
    "items",
    "lastUpdate",
    "nextPurchaseDate",
    "plan",
    "purchaseSettings",
    "shippingAddress",
    "status"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "customerId": {
      "type": "string",
      "nullable": true
    },
    "customerEmail": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "isSkipped": {
      "type": "boolean"
    },
    "nextPurchaseDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastPurchaseDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "plan": {
      "$ref": "#/components/schemas/PlanResponse"
    },
    "shippingAddress": {
      "$ref": "#/components/schemas/ShippingAddressResponse"
    },
    "purchaseSettings": {
      "$ref": "#/components/schemas/PurchaseSettingsResponse"
    },
    "cycleCount": {
      "type": "integer",
      "format": "int32"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdate": {
      "type": "string",
      "format": "date-time"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubscriptionItemResponse"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}