Create Plans

POST

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

POST

/api/merchant/subscription/plans

$ curl -X POST https://api-sandbox.coinflow.cash/api/merchant/subscription/plans \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Premium Streaming Plan",
>   "code": "PREM_STREAM_001",
>   "interval": "Monthly",
>   "amount": {
>     "cents": 999,
>     "currency": "USD"
>   }
> }'

200Successful

1 {
2   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3   "name": "Premium Streaming Plan",
4   "code": "PREM_STREAM_001",
5   "interval": "Monthly",
6   "amount": {
7     "cents": 999,
8     "currency": "USD"
9   },
10   "active": true,
11   "duration": 12,
12   "description": "Access to all premium content with HD streaming quality.",
13   "transaction": "txn_7890abcdef123456",
14   "settlementChain": "solana",
15   "merchantInitiated": false
16 }

Create a new subscription plan

Authentication

Authorizationstring

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

Request

This endpoint expects an object.

namestringRequired

codestringRequired

intervalenumRequired

amountobjectRequired

durationintegerOptional>=1

descriptionstringOptional

transactionstringOptional

settlementChainenumOptional

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

idstring

namestring

codestring

intervalenum

amountobject

activeboolean

durationinteger>=1

descriptionstring

transactionstring

settlementChainenum

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.