Seamless APIs
Create Seamless Subscription with Plan ID
v2025-01-01
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
- Payment Methods
- Offers
- Token Vault
- Disputes
- Settlements
- softPOS
- Simulation
- Subscription
- VBA
- Cross Border
- Utilities
Other Versions
- v2023-08-01
- v2022-01-01
- End Points
- Orders
- Payments
- Payment Links
- Refunds
- Token Vault
- Eligibility
- Offers
- Settlements
- PG Reconciliation
- Settlement Reconciliation
- softPOS
- Subscription
Seamless APIs
Create Seamless Subscription with Plan ID
Use this API to create a subscription by providing a custom payment experience to your customers by specifying the plan ID and the customer details. You can also specify the bank account information when you create the subscription to ensure that mandates are created via the specified bank account only. TPV is applicable only for eNACH and UPI.
POST
/
api
/
v2
/
subscriptions
/
seamless
/
subscription
curl --request POST \
--url https://sandbox.cashfree.com/api/v2/subscriptions/seamless/subscription \
--header 'Content-Type: application/json' \
--data '{
"subscriptionId": "DemoSubscription",
"planId": "TestPlan_ReArch_002",
"customerName": "John",
"customerPhone": "99999XXXXX",
"customerEmail": "john@gmail.com",
"returnUrl": "www.google.com",
"authAmount": 1,
"expiresOn": "2024-12-02 09:20:12",
"firstChargeDate": "2024-12-02",
"payerAccountDetails": {
"accountNumber": "007200000000",
"accountHolderName": "John",
"bankId": "ICIC",
"accountType": "SAVINGS",
"ifsc": "ICIC0000072"
},
"notificationChannels": [
"EMAIL",
"SMS"
]
}'
{
"status": 200,
"message": "Subscription Created",
"data": {
"subReferenceId": 107350,
"subscriptionId": "DemoSubscription",
"customerPhone": "9999988888",
"customerEmail": "demo.email@gmail.com",
"planId": "TestPlan_ReArch_002",
"status": "INITIALIZED",
"currentCycle": 0,
"authAmount": 1,
"returnUrl": "www.google.com",
"startDate": {
"E_MANDATE": "2024-12-02",
"UPI": "2024-12-02"
},
"endDate": "2024-12-02 09:20:12",
"tpvEnabled": false,
"paymentOptions": [
{
"type": "E_MANDATE",
"accountTypes": [
"SAVINGS",
"CURRENT"
],
"frequentBankDetails": [
{
"bankId": "SBIN",
"bankName": "STATE BANK OF INDIA",
"accountAuthModes": [
"DEBIT_CARD",
"NET_BANKING"
]
}
]
}
]
}
}
Headers
Example:
"{{X-Client-Id}}"
Example:
"{{X-Client-Secret}}"
Body
application/json
Response
200
application/json
Successful subscription creation.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://sandbox.cashfree.com/api/v2/subscriptions/seamless/subscription \
--header 'Content-Type: application/json' \
--data '{
"subscriptionId": "DemoSubscription",
"planId": "TestPlan_ReArch_002",
"customerName": "John",
"customerPhone": "99999XXXXX",
"customerEmail": "john@gmail.com",
"returnUrl": "www.google.com",
"authAmount": 1,
"expiresOn": "2024-12-02 09:20:12",
"firstChargeDate": "2024-12-02",
"payerAccountDetails": {
"accountNumber": "007200000000",
"accountHolderName": "John",
"bankId": "ICIC",
"accountType": "SAVINGS",
"ifsc": "ICIC0000072"
},
"notificationChannels": [
"EMAIL",
"SMS"
]
}'
{
"status": 200,
"message": "Subscription Created",
"data": {
"subReferenceId": 107350,
"subscriptionId": "DemoSubscription",
"customerPhone": "9999988888",
"customerEmail": "demo.email@gmail.com",
"planId": "TestPlan_ReArch_002",
"status": "INITIALIZED",
"currentCycle": 0,
"authAmount": 1,
"returnUrl": "www.google.com",
"startDate": {
"E_MANDATE": "2024-12-02",
"UPI": "2024-12-02"
},
"endDate": "2024-12-02 09:20:12",
"tpvEnabled": false,
"paymentOptions": [
{
"type": "E_MANDATE",
"accountTypes": [
"SAVINGS",
"CURRENT"
],
"frequentBankDetails": [
{
"bankId": "SBIN",
"bankName": "STATE BANK OF INDIA",
"accountAuthModes": [
"DEBIT_CARD",
"NET_BANKING"
]
}
]
}
]
}
}