Get Available Plans

GET

https://api-sandbox.coinflow.cash/api/subscription/:merchantId/plans

Get the available subscription plans for a merchant

Authentication

x-coinflow-auth-session-keystring

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

x-coinflow-auth-walletstring

The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

x-coinflow-auth-blockchainstring

The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Path parameters

merchantIdstringRequired

Response

idstring

namestring

codestring

intervalenum

Allowed values:

amountobject

activeboolean

durationintegerOptional>=1

descriptionstringOptional

transactionstringOptional

settlementChainenumOptional

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.