v1
latestOpenAPI 3.0.12026-07-225791279.7 KBSubscription Reads
List Subscription
It retrieves a paginated list of subscriptions belonging to the authenticated merchant.
get/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}
Query parameters
pageinteger required
The page number to be retrieved.
sizeinteger required
The number of records per page.
statusstring required
Filter subscriptions by status.
Response
Request Successful
Example response
{
"success": true,
"message": "Success",
"data": {
"content": [
{
"subscription": {
"id": 22,
"customerId": "test-trial-2",
"customerEmail": "johndoe@gmail.com",
"status": "ACTIVE",
"currentPeriodStart": "2026-07-08T20:45:49.099607",
"currentPeriodEnd": "2026-07-09T20:45:52.188164",
"nextChargeDate": "2026-08-08T21:07:05.155671",
"cancelledAt": "2026-07-08T21:00:56.319038",
"cancellationReason": "Just Testing it out",
"connectionMode": "Live",
"enrollmentReference": "SUBREF_EE9A8CD25F38423B87",
"enrollmentTxnReference": "SUB_ENROLL_22_1783543549106",
"chargeMode": "DIRECT_CHARGE",
"createdAt": "2026-07-08T20:45:49.099614",
"updatedAt": "2026-07-08T21:07:05.158379",
"enrollConfirmed": true
},
"plan": {
"id": 104,
"name": "Basic Monthly Instant",
"description": "Basic tier billed monthly",
"amount": 100,
"currency": "NGN",
"interval": "MONTHLY",
"intervalCount": 1,
"status": "ACTIVE",
"planCode": "PLN_B30D72C",
"createdAt": "2026-07-08T19:51:31.755412",
"updatedAt": "2026-07-08T19:51:31.755414"
}
}
],
"pageable": {
"sort": {
"sorted": true
},
"pageSize": 3,
"paged": true
},
"totalElements": 8,
"totalPages": 3,
"numberOfElements": 3,
"first": true,
"size": 3,
"sort": {
"sorted": true
}
}
}