VTEX · Schema

FrequencyRequest

Information about subscriptions' recurrence.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
periodicity string Defines the subscriptions recurrence period. The possible values are: - `DAILY` - `WEEKLY` - `MONTHLY` - `YEARLY`
interval integer Time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the value will be days, for `MONTHLY` it will be months, and so on.
View JSON Schema on GitHub

JSON Schema

vtex-frequencyrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FrequencyRequest",
  "title": "FrequencyRequest",
  "required": [
    "interval",
    "periodicity"
  ],
  "type": "object",
  "description": "Information about subscriptions' recurrence.",
  "properties": {
    "periodicity": {
      "type": "string",
      "nullable": true,
      "description": "Defines the subscriptions recurrence period. The possible values are: \r\n- `DAILY` \r\n- `WEEKLY` \r\n- `MONTHLY` \r\n- `YEARLY`",
      "example": "MONTHLY"
    },
    "interval": {
      "type": "integer",
      "format": "int32",
      "description": "Time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the value will be days, for `MONTHLY` it will be months, and so on.",
      "example": 3
    }
  },
  "additionalProperties": false
}