Sign in
latestOpenAPI 3.1.02026-08-221961,012719.3 KB

c6be39c0cb2f

subscription

Get Plan

Get a specific subscription plan

get/subscription/{merchantId}/plans/{code}

Path parameters

merchantIdstring required
codestring required

Headers

x-coinflow-auth-session-keystring required

The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

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.