VTEX · Schema

SubscriptionUpdateRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
title	string	Name of the subscription.
status	string	Status to which you wish to update the subscription. The accepted values are: - `ACTIVE` - `PAUSED` - `CANCELED` - `EXPIRED` - `MISSING`
isSkipped	boolean	When set as `true`, it means the shopper asked to skip the next subscription order, and when set as `false`, no subscription order is going to be skipped.
plan	object
shippingAddress	object
purchaseSettings	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionUpdateRequestV3",
  "title": "SubscriptionUpdateRequest",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "nullable": true,
      "description": "Name of the subscription.",
      "example": "catFood"
    },
    "status": {
      "type": "string",
      "nullable": true,
      "description": "Status to which you wish to update the subscription. The accepted values are: \r\n- `ACTIVE` \r\n- `PAUSED` \r\n- `CANCELED` \r\n- `EXPIRED` \r\n- `MISSING`",
      "example": "ACTIVE"
    },
    "isSkipped": {
      "type": "boolean",
      "nullable": true,
      "description": "When set as `true`, it means the shopper asked to skip the next subscription order, and when set as `false`, no subscription order is going to be skipped.",
      "example": false
    },
    "plan": {
      "$ref": "#/components/schemas/PlanThinRequest"
    },
    "shippingAddress": {
      "$ref": "#/components/schemas/shippingAddress"
    },
    "purchaseSettings": {
      "$ref": "#/components/schemas/PurchaseSettingsThinRequest"
    }
  },
  "additionalProperties": false
}