MultiLinkSubscription | ePay documentation

Subscription settings stored on a multi-link.

amountinteger

Nullable

The configured recurring amount in minor units.

Example:

1095

typestring

Nullable

The configured subscription type.

Possible values:

"SCHEDULED""UNSCHEDULED"

Example:

"SCHEDULED"

expiryDatestring

Nullable

The configured subscription expiry date.

Format:

date

Example:

"2027-12-31"

The configured scheduled-subscription interval.

The configured automatic billing agreement.

MultiLinkSubscription

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