v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Subscription Reads

Subscription Charge History

It retrieves the billing history for a subscription.

get/subscription/api/v1/subscriptions/{id}/charges?page={page}&size={size}

Path parameters

idinteger required

The unique identifeir of the subscription.

Query parameters

pageinteger required

The page number to be retrieved.

sizeinteger required

The number of records per page.

Response

Request Successful

successboolean

Indicates if the request was successful.

messagestring

Descriptive message regarding the operation.

Example response

{
  "success": true,
  "message": "Success",
  "data": {
    "content": [
      {
        "id": 3,
        "subscriptionId": 21,
        "cycleNumber": 1,
        "attemptNumber": 1,
        "transactionReference": "SUB_ENROLL_21_1783539495235",
        "amount": 1000,
        "currency": "NGN",
        "description": "Subscription cycle 1 (enrollment charge)",
        "status": "SUCCESS",
        "chargedAt": "2026-07-08T19:38:18.30726",
        "createdAt": "2026-07-08T19:38:18.307196",
        "updatedAt": "2026-07-08T19:38:18.307197"
      }
    ],
    "pageable": {
      "sort": {
        "unsorted": true,
        "empty": true
      },
      "pageSize": 20,
      "paged": true
    },
    "totalElements": 5,
    "totalPages": 1,
    "last": true,
    "numberOfElements": 5,
    "first": true,
    "size": 20,
    "sort": {
      "unsorted": true,
      "empty": true
    }
  }
}