VTEX · Schema

SubscriptionRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
customerEmail string
title string
status string
nextPurchaseDate string
catalogAttachment string
plan object
shippingAddress object
purchaseSettings object
items array
View JSON Schema on GitHub

JSON Schema

vtex-subscriptiongrouprequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionGroupRequest",
  "title": "SubscriptionRequest",
  "required": [
    "customerEmail",
    "items",
    "plan",
    "purchaseSettings",
    "shippingAddress"
  ],
  "type": "object",
  "properties": {
    "customerEmail": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "nextPurchaseDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "catalogAttachment": {
      "type": "string",
      "nullable": true
    },
    "plan": {
      "$ref": "#/components/schemas/PlanThinRequest"
    },
    "shippingAddress": {
      "$ref": "#/components/schemas/shippingAddress"
    },
    "purchaseSettings": {
      "$ref": "#/components/schemas/PurchaseSettingsThinRequest"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubscriptionThinItemRequest"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}