Sign in
OpenAPI 3.1.02026-08-201961,012712.7 KB

04665b9b9725

merchantSubscription

Create Plans

Create a new subscription plan

post/merchant/subscription/plans

Headers

Authorizationstring required

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request body

namestring required
codestring required
interval'Daily' | 'Weekly' | 'Monthly' | 'Yearly' required
durationinteger
descriptionstring
transactionstring
activeboolean
merchantInitiatedboolean

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 required
namestring required
codestring required
interval'Daily' | 'Weekly' | 'Monthly' | 'Yearly' required
durationinteger
descriptionstring
transactionstring
activeboolean required
merchantInitiatedboolean

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.