Get Available 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

durationinteger or null>=1

descriptionstring or null

transactionstring or null

settlementChainenum or null

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.

1	import requests
2
3	url = "https://api-sandbox.coinflow.cash/api/subscription/merchantId/plans"
4
5	payload = {}
6	headers = {
7	"x-coinflow-auth-session-key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.get(url, json=payload, headers=headers)
12
13	print(response.json())

1	[
2	{
3	"id": "plan_8f3b2c1d9a4e",
4	"name": "Premium Monthly Plan",
5	"code": "PREM_MONTHLY",
6	"interval": "Monthly",
7	"amount": {
8	"cents": 2999,
9	"currency": "USD"
10	},
11	"active": true,
12	"duration": 12,
13	"description": "Access to all premium features billed monthly for one year.",
14	"transaction": "txn_5a7c9e3f2b1d",
15	"settlementChain": "arbitrum",
16	"merchantInitiated": false
17	}
18	]