Subscription
Get Subscription Details
v2023-08-01
- End Points
- Release Notes
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
- Eligibility
- Offers
- Operations
- Partners
- Token Vault
- softPOS
- Simulation
- Subscription
- Cross Border
Other Versions
- v2022-01-01
- End Points
- Orders
- Payments
- Payment Links
- Refunds
- Token Vault
- Eligibility
- Offers
- Settlements
- PG Reconciliation
- Settlement Reconciliation
- softPOS
- Subscription
- Postman Collection
- End Points
- Physical Mandates
- Seamless APIs
- Subscription Refund
- Subscription
- GETGet Subscription Details
- PUTUpdate Recurring Amount
- GETFetch Subscription Payments
- GETFetch Single Subscription Payment
- GETFetch Payment by Merchant Transaction ID
- POSTCancel Subscription
- PUTPause Subscription
- POSTCharge Subscription
- POSTRetry Subscription Charge
- POSTUpload Physical Mandate File
- POSTActivate Subscription
- POSTCancel Subscription Charge
- PUTUpdate Charge Status
- POSTGenerate Transaction Return Summary
- POSTCreate a Subscription Plan
- POSTCreate a Subscription
- GET
- Redirection Payload after Authorization
- Rate Limits
- Webhooks
Upcoming Versions
- v2025-01-01 (beta)
Subscription
Get Subscription Details
Fetch the details of a subscription for a specific subscription reference ID.
GET
/
api
/
v2
/
subscriptions
/
{subReferenceId}
{
"status": "OK",
"message": "Subscription Details",
"subscription": {
"subscriptionId": "SUB-1",
"subReferenceId": 127056,
"planId": "Basic-1",
"customerName": "John Doe",
"customerEmail": "johndoe@gmail.com",
"customerPhone": "9999999999",
"mode": "NPCI_SBC",
"status": "ACTIVE",
"firstChargeDate": null,
"addedOn": "2021-12-16 16:20:52",
"scheduledOn": "2021-12-16 20:30:02",
"currentCycle": 0,
"authLink": "http://cfre.in/t9i2oku",
"bankAccountNumber": "5XXXXXXXXXXXXX",
"bankAccountHolder": "John Doe",
"umrn": "HDFCXXXXXXXXXXXXXXXX",
"splitDetails": {
"scheme": [
{
"merchantVendorId": "test-vendor-1",
"percentage": 10
},
{
"merchantVendorId": "test-vendor-2",
"percentage": 10
}
]
}
}
}
Headers
Client ID provided by Cashfree.
Client Secret provided by Cashfree.
Path Parameters
The reference ID of the subscription whose details are to be fetched.
Response
200 - application/json
The response is of type any
.
Was this page helpful?
{
"status": "OK",
"message": "Subscription Details",
"subscription": {
"subscriptionId": "SUB-1",
"subReferenceId": 127056,
"planId": "Basic-1",
"customerName": "John Doe",
"customerEmail": "johndoe@gmail.com",
"customerPhone": "9999999999",
"mode": "NPCI_SBC",
"status": "ACTIVE",
"firstChargeDate": null,
"addedOn": "2021-12-16 16:20:52",
"scheduledOn": "2021-12-16 20:30:02",
"currentCycle": 0,
"authLink": "http://cfre.in/t9i2oku",
"bankAccountNumber": "5XXXXXXXXXXXXX",
"bankAccountHolder": "John Doe",
"umrn": "HDFCXXXXXXXXXXXXXXXX",
"splitDetails": {
"scheme": [
{
"merchantVendorId": "test-vendor-1",
"percentage": 10
},
{
"merchantVendorId": "test-vendor-2",
"percentage": 10
}
]
}
}
}