Authorizations
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
Body
Request body to create a new subscription.
A unique ID for the subscription. It can include alphanumeric characters, underscore, dot, hyphen, and space. Maximum characters allowed is 250.
1 - 250
Subscription customer details.
{
"customer_name": "Test Cust",
"customer_email": "test@gmail.com",
"customer_phone": "9900755700",
"customer_bank_account_holder_name": "",
"customer_bank_account_number": "",
"customer_bank_ifsc": "",
"customer_bank_code": "",
"customer_bank_account_type": ""
}
Expiry date for the subscription.
Time at which the first charge will be made for the subscription after authorization. Applicable only for PERIODIC plans.
Custom Tags in the form of {"key":"value"} which can be passed for a subscription. A maximum of 10 tags can be added
{
"psp_note": "Monthly subscription payment"
}
Payment splits for the subscription.
Response
Subscription Created
The response returned for Get, Create or Manage Subscription APIs.
Details of the authorization done for the subscription. Returned in Get subscription and auth payments.
{
"authorization_amount": 1,
"authorization_amount_refund": false,
"authorization_reference": "",
"authorization_time": "2022-06-14T23:47:52+05:30",
"authorization_status": "INITIALIZED",
"payment_id": "97877",
"payment_method": "NPCI_SBC"
}
Cashfree subscription reference number
Subscription customer details.
{
"customer_name": "Test Cust",
"customer_email": "test@gmail.com",
"customer_phone": "9900755700",
"customer_bank_account_holder_name": "",
"customer_bank_account_number": "",
"customer_bank_ifsc": "",
"customer_bank_code": "",
"customer_bank_account_type": ""
}
The response returned for Get, Create and Manage Plan APIs
{
"plan_currency": "INR",
"plan_id": "144436-03471-JD_TEST",
"plan_interval_type": "WEEK",
"plan_intervals": 1,
"plan_max_amount": 1,
"plan_max_cycles": 4,
"plan_name": "abscede",
"plan_note": "lsdkdn",
"plan_recurring_amount": 1,
"plan_status": "ACTIVE",
"plan_type": "PERIODIC"
}
Time at which the subscription will expire.
Time at which the first charge will be made for the subscription. Applicable only for PERIODIC plans.
A unique ID passed by merchant for identifying the subscription.
Subscription metadata.
Subscription Session Id.
Payment splits for the subscription.
Status of the subscription.
Tags for the subscription.