Skip to main content

CreateSubscriptionRequest

customerIdstringrequired
customerEmailstring<email>required
storedTokenIdstringrequired
planNamestringrequired

Possible values: non-empty

amountintegerrequired

Possible values: >= 1

currencyCurrencyCode (string)required

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

Examples:
Example: USD
intervalstringrequired
intervalCountintegerrequired

Possible values: >= 1

startDatestringrequired
endDatestringnullable
maxCyclesintegernullable

Possible values: >= 1

webhookUrlstringnullable
metadata objectnullable
property name*anynullable
CreateSubscriptionRequest
{
"customerId": "string",
"customerEmail": "[email protected]",
"storedTokenId": "string",
"planName": "string",
"amount": 0,
"currency": "USD",
"interval": "string",
"intervalCount": 0,
"startDate": "string",
"endDate": "string",
"maxCycles": 0,
"webhookUrl": "string",
"metadata": {}
}