CreateSubscriptionRequest

customerIdstringrequired

customerEmailstring<email>required

savedPaymentMethodIdstringrequired

Canonical saved payment method id as returned by the saved payment methods API. Opaque; never a provider token or an internal vault id.

planNamestringrequired

Possible values: non-empty

amountintegerrequired

Possible values: >= 1

currencyCurrencyCoderequired

Possible values: Value must match regular expression ^[A-Z]{3}$

Examples:

Example 1
Example 2
Example 3

Example: USD

Example: EUR

Example: GBP

intervalstringrequired

intervalCountintegerrequired

Possible values: >= 1

startDatestringrequired

endDatestringnullable

maxCyclesintegernullable

Possible values: >= 1

webhookUrlstringnullable

metadata objectnullable

property name*string

CreateSubscriptionRequest
{
  "customerId": "string",
  "customerEmail": "[email protected]",
  "savedPaymentMethodId": "string",
  "planName": "string",
  "amount": 0,
  "currency": "USD",
  "interval": "string",
  "intervalCount": 0,
  "startDate": "string",
  "endDate": "string",
  "maxCycles": 0,
  "webhookUrl": "string",
  "metadata": {}
}