Skip to main content
POST
/
api
/
v2
/
subscription-plans
Create a Subscription Plan
curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscription-plans \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>' \
  --data '{
  "planId": "1682406696",
  "planName": "Plan 1682406656",
  "type": "PERIODIC",
  "recurringAmount": 10,
  "maxAmount": 100,
  "intervals": 1,
  "intervalType": "month"
}'
{
  "message": "Plan created successfully",
  "status": "OK",
  "data": {
    "planId": "1682406696",
    "planName": "Plan 1682406656",
    "type": "PERIODIC",
    "currency": "INR",
    "amount": 10,
    "maxAmount": 100,
    "intervals": 1,
    "intervalType": "month",
    "isActive": true,
    "addedOn": "2023-04-25 13:50:17"
  }
}

Headers

ā€‹
X-Client-Id
string
required

Client ID provided by Cashfree.

Example:

"asdf1234"

ā€‹
X-Client-Secret
string
required

Client Secret provided by Cashfree.

Example:

"qwer9876"

Body

application/json
ā€‹
planId
string

Unique ID for the subscription plan.

Example:

"1682406696"

ā€‹
planName
string

Name of the subscription plan.

Example:

"Plan 1682406656"

ā€‹
type
enum<string>

The type of the subscription plan.

Available options:
PERIODIC,
ON_DEMAND
Example:

"PERIODIC"

ā€‹
recurringAmount
number

Recurring amount for the plan.

Example:

10

ā€‹
maxAmount
number

Maximum amount for the plan.

Example:

100

ā€‹
intervals
integer

Number of intervals for the periodic plan.

Example:

1

ā€‹
intervalType
enum<string>

Interval type for the periodic plan.

Available options:
day,
week,
month,
year
Example:

"month"

Response

Subscription plan created successfully.

The response is of type any.