CreateMultiLinkSubscriptionRequest

Subscription settings applied to every payment session started from a multi-link.

amountinteger

Nullable

The recurring subscription amount in minor units. When omitted, the multi-link payment amount is used.

Range:

0 <= value

Example:

1095

typestring

Required

The subscription type. SCHEDULED is for fixed-interval charges and UNSCHEDULED is for pay-as-you-go charges.

Possible values:

"SCHEDULED""UNSCHEDULED"

Example:

"SCHEDULED"

expiryDatestring

Nullable

An optional future subscription-expiry date in YYYY-MM-DD format.

Format:

date

Example:

"2027-12-31"

The charge interval for a SCHEDULED subscription. Omit it for an UNSCHEDULED subscription and when billingAgreement is present.

Optional automatic-billing agreement to create for a SCHEDULED subscription. This feature must be enabled for the account.

CreateMultiLinkSubscriptionRequest

{  "amount": 1095,  "type": "SCHEDULED",  "expiryDate": "2027-12-31",  "interval": {    "period": "MONTH",    "frequency": 1  },  "billingAgreement": {    "billingPlanId": "019a7266-2f3a-7b26-9c93-b950aea9e13c",    "nextChargeAt": "2027-01-01"  }}