Create Subscription

Body Params
string
string
required

Created from Create Mandate API

string

For receiving possible invoice emails

string
required

ISO 4217

string
required

e.g. "1.00" in USD

string
string
enum
required

Interval unit for this subscription

Allowed:
int32
required

Total invoice times for this subscription, must > 1.
The value of "times" must not exceed a maximum period of 5 years. In other words, if interval_unit = year, then times <= 5; if interval_unit = month, then times <= 12 * 5.

int32
Defaults to 1

The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months.
The entire cycle must not exceed five years, i.e., interval_count times ≤ maxTimesByIntervalUnit (which varies depending on the interval_unit: day: 3655=1825, month: 125=60, quarter: 45=20, year: 5). For example, for a monthly interval, the maximum value must not exceed 60.

string

if the subscription has a trial, the end of that trial, format‘Y-m-d’. Example 2025-07-23

json

Custom fields

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json