API Reference

Subscription

object
token
string
1 validation + required
planName
string
1 validation + required
periodicity
string

Use custom for on-demand subscriptions

2 validations + required
contactDetails
object

Use this object if you want to validate the warning rules when creating the subscription

ignoreWarnings
boolean

Set this parameter to true if you want to continue creating the subscription despite de warning rules

amount
object
2 validations + required
startDate
string

YYYY-MM-DD

Note: Use future date

2 validations + required
endDate
string

YYYY-MM-DD

Note: Use a future date regarding to startDate

2 validations
language
string
1 validation
retryConfiguration
object

Use this object if you want to configure retries different than default

1 validation
metadata
object