v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Subscription Invoices

List Invoices

This retrieves a paginated list of invoices belonging to the authenticated merchant.

get/subscription/api/v1/invoices?status={status}&subscriptionId={subscriptionId}&from={from}&to={to}&page={page}&size={size}

Query parameters

statusstring required

Filter invoices by status.

subscriptionIdinteger required

Filter invoices by subscription ID.

fromstring date-time required

Start date and time for the invoice search.

tostring date-time required

End date and time for the invoice search.

pageinteger required

The page number to retrieve.

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": 7,
        "invoiceNumber": "INV-21-C3",
        "subscriptionId": 21,
        "cycleNumber": 3,
        "amount": 1000,
        "currency": "NGN",
        "status": "DRAFT",
        "dueDate": "2026-07-09T20:20:32.893236",
        "connectionMode": "Live",
        "createdAt": "2026-07-08T20:20:32.953095",
        "updatedAt": "2026-07-08T20:20:32.953097"
      }
    ],
    "pageable": {
      "sort": {
        "sorted": true
      },
      "pageSize": 10,
      "paged": true
    },
    "totalElements": 3,
    "totalPages": 1,
    "last": true,
    "numberOfElements": 3,
    "first": true,
    "size": 10,
    "sort": {
      "sorted": true
    }
  }
}