API ReferenceMerchant Subscription

Create Plans

Create a new subscription plan

Authentication

Request

This endpoint expects an object.
namestringRequired
codestringRequired
intervalenumRequired
Allowed values:
amountobjectRequired
durationintegerOptional>=1
descriptionstringOptional
transactionstringOptional
settlementTypeenumOptional
Allowed values:
activebooleanOptional
merchantInitiatedbooleanOptional
Only specify this as true if you do not want subscription payments automatically processed. Then you will be responsible for manually calling the merchant initiated transaction endpoint.

Response

Ok
idstring
namestring
codestring
intervalenum
Allowed values:
amountobject
activeboolean
durationinteger or null>=1
descriptionstring or null
transactionstring or null
settlementTypeenum or null
Allowed values:
merchantInitiatedboolean or null
Only specify this as true if you do not want subscription payments automatically processed. Then you will be responsible for manually calling the merchant initiated transaction endpoint.