List Subscriptions
Retrieve subscriptions created in the environment selected by your secret key.
Endpoint
GET https://backendapi.sayswitchgroup.com/api/v1/subscriptionRequest
curl --request GET \
--url "https://backendapi.sayswitchgroup.com/api/v1/subscription?status=active&per_page=20" \
--header "Authorization: Bearer YOUR_SECRET_KEY" \
--header "Accept: application/json"Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Return subscriptions matching the supplied status. Use a public subscription status. |
per_page | integer | No | Results per page, from 1 to 100. Defaults to 20. |
page | integer | No | Page number to retrieve. |
Values below 1 for per_page are treated as 1, and values above 100 are treated as 100.
Response
{
"status": true,
"data": {
"current_page": 1,
"data": [
{
"id": 84,
"subscription_code": "SUB_7q2m9x4k1v8b5n3p6r0s",
"return_url": "https://merchant.example/subscription/complete",
"status": "active",
"start_at": "2026-10-01T00:00:00.000000Z",
"next_charge_at": "2026-10-01T00:00:00.000000Z",
"cancelled_at": null,
"successful_charge_count": 0,
"metadata": {
"merchant_order_id": "EMAIL-ORDER-001"
},
"domain": "test",
"plan": {
"plan_code": "PLN_plan_code",
"name": "Email Monthly",
"amount": "15000.00",
"currency": "NGN",
"interval": "monthly"
},
"customer": {
"customer_code": "CUS_customer_code",
"email": "customer@example.com"
},
"payment_method": {
"payment_method_code": "PM_8r3n1v6q4m9x2k7b5p0s",
"brand": "mastercard",
"last4": "0008",
"exp_month": "01",
"exp_year": "39",
"status": "active"
}
}
],
"first_page_url": "https://backendapi.sayswitchgroup.com/api/v1/subscription?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://backendapi.sayswitchgroup.com/api/v1/subscription?page=1",
"next_page_url": null,
"path": "https://backendapi.sayswitchgroup.com/api/v1/subscription",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 1
}
}The API response includes related plan, customer, and saved payment-method records where available. The example focuses on merchant-relevant fields; never store or expect raw card details or provider tokens. The pagination object also includes a links array.