VTEX · Schema

PlanRequest

Information about the plan.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string ID of the plan.
frequency object
validity object
purchaseDay string Day in which recurrent orders will be created.
View JSON Schema on GitHub

JSON Schema

vtex-planthinrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlanThinRequest",
  "title": "PlanRequest",
  "description": "Information about the plan.",
  "required": [
    "frequency",
    "id",
    "purchaseDay"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the plan.",
      "example": "store.subscription"
    },
    "frequency": {
      "$ref": "#/components/schemas/FrequencyRequest"
    },
    "validity": {
      "$ref": "#/components/schemas/ValidityRequest"
    },
    "purchaseDay": {
      "type": "string",
      "description": "Day in which recurrent orders will be created.",
      "nullable": true,
      "example": "15"
    }
  },
  "additionalProperties": false
}