Subscription Plan
Get Subscription Plan Details
Retrieve detailed information about a specific subscription plan including billing, terms, and payment schedule.
Get Subscription Plan Details
Version: 3.0.0
Generate an API Key for the Subscription channel before making requests.
Use this endpoint to retrieve detailed information about a specific subscription plan. The response includes the full plan configuration, billing frequency, installment amounts, terms, status, payment schedule, and associated QR code and payment link.
Endpoint
| Method | URL |
|---|---|
| GET | https://api.payorc.com/subscriptions/v1/details |
Please use the test credentials for sandbox testing.
Authentication
Include the following headers in every request:
| Header | Type | Description |
|---|---|---|
merchant-key | String | Your merchant key |
merchant-secret | String | Your merchant secret |
All API requests must be made over HTTPS. Requests made over plain HTTP will be rejected.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
data_id | String | Yes | Encrypted plan identifier from Plan List or create-plan response. |
Use data_id from Plan List — not the plain plan_id display number.
Response (200 OK)
| Field | Type | Description |
|---|---|---|
data | Object | Plan details object |
data.data_id | String | Encrypted plan identifier (same value used in API requests) |
data.merchant_name | String | Name of the merchant |
data.super_merchant_name | String | Name of the super merchant |
data.plan_id | String | Plain display plan number |
data.plan_name | String | Plan name |
data.plan_description | String | Plan description |
data.billing_frequency | Object | Billing frequency details |
data.billing_frequency.frequency | String | Billing frequency type (e.g., Daily, Monthly) |
data.billing_frequency.interval | Number | Billing frequency interval |
data.installment_amount | Object | Installment amount details |
data.installment_amount.currency | String | Currency of the installment amount |
data.installment_amount.value | String | Value of the installment amount |
data.terms | Object | Terms of the plan |
data.terms.unlimited | String | Whether terms are unlimited |
data.terms.value | Number | String |
data.terms.discount_term | Number | Discount term value |
data.terms.discount_amount | String | Discount amount |
data.status | String | Status of the plan: Active, Deactivated, or Expired |
data.start_date | String | Start date (DD-MM-YYYY HH:mm:ss) |
data.expiry_date | String | Expiry date (DD-MM-YYYY HH:mm:ss) |
data.initial_payment_amount | String | Initial payment amount |
data.final_payment_amount | String | Final payment amount |
data.shipping_fee | Number | Shipping fee |
data.convenience_fee | Number | Convenience fee |
data.note | String | Additional notes |
data.product_details | String | Product details |
data.qr_code | String | Base64-encoded image data (data URI) of the plan's QR code |
data.payment_link | String | Payment link URL |
data.payment_schedule | Array | Array of payment schedule entries |
data.payment_schedule[].sr_no | Number | Serial number |
data.payment_schedule[].payment | String | Payment label. One of Initial Payment (first term), an ordinal word label such as Second payment / Third payment (intermediate terms), or Final Payment (last term) |
data.payment_schedule[].amount | String | Payment amount |
message | String | Human-readable status message |
status | String | success or error |
code | String | Status code (00 for success) |
Code Examples
curl -X GET "https://api.payorc.com/subscriptions/v1/details?data_id=ak80VjZGeURhT2hSM" \
-H "merchant-key: YOUR_MERCHANT_KEY" \
-H "merchant-secret: YOUR_MERCHANT_SECRET"Example Response
{
"data": {
"data_id": "ak80VjZGeURhT2hSM",
"merchant_name": "MUSIC COMPANY pvt",
"super_merchant_name": "Utkarsha Patil",
"plan_id": "10000145",
"plan_name": "Shree ram yatra",
"plan_description": "Pran pratishtha samaroh",
"billing_frequency": {
"frequency": "Daily",
"interval": 2
},
"installment_amount": {
"currency": "AED",
"value": "300.00"
},
"terms": {
"unlimited": "no",
"value": 20,
"discount_term": 5,
"discount_amount": "90.00"
},
"status": "Active",
"start_date": "19-02-2024 23:50:00",
"expiry_date": "25-02-2024 23:59:00",
"initial_payment_amount": "109.00",
"final_payment_amount": "80.00",
"shipping_fee": "20",
"convenience_fee": "10",
"note": "",
"product_details": "",
"qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
"payment_link": "https://example.com/pay/{plan_id}",
"payment_schedule": [
{
"sr_no": 1,
"payment": "Initial Payment",
"amount": "139.00"
},
{
"sr_no": 2,
"payment": "Second payment",
"amount": "120.00"
},
{
"sr_no": 20,
"payment": "Final Payment",
"amount": "110.00"
}
]
},
"message": "Details fetched successfully.",
"status": "success",
"code": "00"
}The data_id is returned when you create a plan or list plans. Use it to fetch the full details of any plan.