Subscriptions
Read endpoint for subscriptions. To create one see Create a subscription; to cancel or reschedule see Cancel or reschedule.
List subscriptions
/api/v1/subscriptions/Lists the seller's active subscriptions. Paginated — see Page through list results. The envelope adds status counts.
Response envelope
| Field | Type | Description |
|---|---|---|
count | integer | Total rows |
next / previous | string | null | Page URLs |
total_subscriptions | integer | Same as count |
active_subscriptions | integer | Status-classified count |
due_subscriptions | integer | — |
inactive_subscriptions | integer | — |
results | array | See Subscription item |
Field shapes for results[], including the nested client and product objects, are in Object fields. Status values are in Subscription statuses.
Example response
{
"count": 85,
"next": "https://be.suqo.ai/api/v1/subscriptions?page=2",
"previous": null,
"total_subscriptions": 85,
"active_subscriptions": 60,
"due_subscriptions": 10,
"inactive_subscriptions": 15,
"results": [
{
"subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "active",
"is_active": true,
"client": {
"phone": "9800000001",
"full_name": "John Doe",
"email": "[email protected]",
"address": "Kathmandu, Nepal",
"billing": {
"business_name": "ABC Pvt Ltd.",
"email": "[email protected]",
"address": "Kathmandu, Nepal",
"pan_vat": "111111111"
},
"shipping": {
"phone": "9800000001",
"full_name": "John Doe",
"email": "[email protected]",
"address": "Kathmandu, Nepal"
}
},
"product": {
"product_id": "205293a1-84f4-426e-8f8c-5ddb239e5d2f",
"name": "Pro Plan Bundle",
"plan_name": "Basic",
"pbp_id": "pbp_3n9k2x",
"label": "Monthly",
"price": "999.00",
"currency": "NPR"
},
"current_period_start": "2026-07-03T00:00:00Z",
"current_period_end": "2026-08-03T00:00:00Z",
"next_billing_cycle": "2026-08-03T00:00:00Z",
"created_at": "2026-07-03T10:15:00Z"
}
]
}