> ## Documentation Index > Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt > Use this file to discover all available pages before exploring further. # List Invoices > This retrieves a paginated list of invoices belonging to the authenticated merchant. ## OpenAPI ````yaml /openapi.json get /subscription/api/v1/invoices?status={status}&subscriptionId={subscriptionId}&from={from}&to={to}&page={page}&size={size} openapi: 3.0.1 info: title: Payaza Documentation version: 2.0.0 description: >- API reference for processing payments using Card, Bank Transfer, USSD, and QR Code methods. servers: - url: https://api.payaza.africa/live security: - ApiKeyAuth: [] - TenantID: [] - ProductID: [] tags: - name: Transfers description: >- Transfers are transactions made from your Payaza account to beneficiaries. Merchants can instantly transfer funds from their available balance. For every transfer, you need to specify the amount and the beneficiary’s details. You become eligible to make transfers after you have been verified. (you sign up, finish account activation and KYC verification). - name: Payaza Account description: >- This is our internal account that can be used to make payouts to other bank accounts, in single or in bulk. The Payaza account can also be used to receive settlements. It can also be used to track the transfer status of your transactions and check your balance instantly - name: Sub Accounts description: >- This enables you to establish Sub Payaza accounts for your customers. Each sub-account comes with an assigned static virtual account, facilitating direct funding for individual accounts. Furthermore, the Main Payaza account can directly initiate funding for each sub-account. These sub-accounts serve the purpose of managing unique account positions or balances and facilitating disbursements from these positions to specified beneficiaries. - name: EUR Accounts description: >- This endpoints enable you to create EUR subaccounts which can be used to make transfers as required . - name: Apple Pay and Google Pay description: >- Apple Pay and Google Pay give your customers a fast, familiar, and secure way to complete payments. Our APIs provide a gateway to provide these services to your users for a smooth payment experience. - name: Virtual Accounts description: >- Virtual Accounts are bank accounts that are created for a specific purpose and last for specified durations. Virtual accounts are issued by Payaza’s partner banks. Our virtual account APIs can be used to create virtual accounts and perform other tasks relevant to virtual accounts. Virtual accounts are created to foster easy payment collections for your business and platform. Static/Reserved Account: This virtual account is created by the merchant and remains valid indefinitely. It can be used multiple times and does not expire. Dynamic Account: This virtual account is generated for a specific transaction or purpose. Please note that dynamic virtual account remains valid for a temporary period of time or until a payment of the specified amount is received. Upon expiry, a merchant can generate another one for a different purpose. - name: Card Collection description: >- The Card Collection APIs can be used to make card transactions, refund transactions that have been performed, check the status of a transaction and so much more. - name: Card Tokenisation description: >- The Card Tokenisation APIs are used to create card tokens, charge cards using tokens, retrieve all tokens created by a merchant account and deleting any card token as desired. - name: Refunds And Chargebacks description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Branches description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Auth-Capture-Void description: >- The Auth-Capture-Void APIs provide a two-phase payment process where transactions are first authorized, then captured or voided. This allows merchants to hold funds and complete the transaction in the future. - name: Momo and ZAR Collections description: APIs for MoMo, ZAR and XOF collections. - name: Check Transaction Status(Merchant Reference) description: >- This endpoint is used to check the transaction status of a transaction using the Merchant Reference.. paths: /subscription/api/v1/invoices?status={status}&subscriptionId={subscriptionId}&from={from}&to={to}&page={page}&size={size}: get: tags: - Subscription Invoices summary: List Invoices description: >- This retrieves a paginated list of invoices belonging to the authenticated merchant. parameters: - name: status in: query required: true schema: type: string description: Filter invoices by status. - name: subscriptionId in: query required: true schema: type: integer description: Filter invoices by subscription ID. - name: from in: query required: true schema: type: string format: date-time description: Start date and time for the invoice search. - name: to in: query required: true schema: type: string format: date-time description: End date and time for the invoice search. - name: page in: query required: true schema: type: integer description: The page number to retrieve. - name: size in: query required: true schema: type: integer description: The number of records per page. responses: '200': description: Request Successful content: application/json: schema: $ref: '#/components/schemas/listInvoicesResponse' examples: List Invoices: summary: List Invoices value: success: true message: Success data: content: - id: 7 invoiceNumber: INV-21-C3 subscriptionId: 21 cycleNumber: 3 chargeId: null amount: 1000 currency: NGN status: DRAFT dueDate: '2026-07-09T20:20:32.893236' issuedAt: null paidAt: null connectionMode: Live createdAt: '2026-07-08T20:20:32.953095' updatedAt: '2026-07-08T20:20:32.953097' - id: 6 invoiceNumber: INV-21-C2 subscriptionId: 21 cycleNumber: 2 chargeId: 9 amount: 20 currency: NGN status: PAID dueDate: '2026-07-09T19:38:18.292411' issuedAt: '2026-07-08T20:20:29.53358' paidAt: '2026-07-08T20:20:32.903649' connectionMode: Live createdAt: '2026-07-08T20:20:29.48334' updatedAt: '2026-07-08T20:20:32.910372' - id: 3 invoiceNumber: INV-21-C1 subscriptionId: 21 cycleNumber: 1 chargeId: null amount: 1000 currency: NGN status: PAID dueDate: '2026-07-08T19:38:15.229726' issuedAt: null paidAt: '2026-07-08T19:38:18.339517' connectionMode: Live createdAt: '2026-07-08T19:38:18.325812' updatedAt: '2026-07-08T19:38:18.341983' pageable: sort: sorted: true unsorted: false empty: false pageNumber: 0 pageSize: 10 offset: 0 paged: true unpaged: false totalElements: 3 totalPages: 1 last: true numberOfElements: 3 first: true size: 10 number: 0 sort: sorted: true unsorted: false empty: false empty: false '400': description: Invalid request security: - ApiKeyAuth: - Payaza {{Public API Key In Base64}} components: schemas: listInvoicesResponse: title: List Invoices Response type: object properties: success: type: boolean description: Indicates if the request was successful. example: true message: type: string description: Descriptive message regarding the operation. example: Success data: type: object description: The payload containing the detailed, paginated list of invoices. properties: content: type: array description: The array of comprehensive invoice records. items: type: object properties: id: type: integer description: Unique internal identifier for the invoice. example: 7 invoiceNumber: type: string description: The unique, human-readable invoice reference identifier. example: INV-21-C3 subscriptionId: type: integer description: >- The identifier of the subscription associated with this invoice. example: 21 cycleNumber: type: integer description: >- The specific billing cycle sequence number this invoice represents. example: 3 chargeId: type: integer nullable: true description: >- The transaction charge identifier tracking processing execution. Null if unpaid or draft. example: null amount: type: number description: >- The financial total amount billed on this invoice statement. example: 1000 currency: type: string description: The 3-letter ISO currency code context attribute mapping. example: NGN status: type: string description: >- The transaction state of the invoice entity (e.g., DRAFT, PAID, UNPAID). example: DRAFT dueDate: type: string format: date-time description: >- Timestamp tracking execution deadlines when payment collection finishes limit window lapses. example: '2026-07-09T20:20:32.893236' issuedAt: type: string format: date-time nullable: true description: >- Timestamp indicating exactly when the invoice was finalized and issued to the consumer layer. example: null paidAt: type: string format: date-time nullable: true description: >- Timestamp detailing absolute resolution validation completion settlement clearing. example: null connectionMode: type: string description: Environment tracking contextual mode tag indicator. example: Live createdAt: type: string format: date-time description: Record timeline insertion timestamp log entry. example: '2026-07-08T20:20:32.953095' updatedAt: type: string format: date-time description: Record database modification tracking log entry baseline. example: '2026-07-08T20:20:32.953097' pageable: type: object description: >- Pagination sorting configuration parameters state snapshot context meta object properties layout. properties: sort: type: object properties: unsorted: type: boolean example: false sorted: type: boolean example: true empty: type: boolean example: false pageNumber: type: integer description: The current page selection counter index. example: 0 pageSize: type: integer description: The requested payload size limits constraint applied. example: 10 offset: type: integer description: >- The mathematical structural record array pointer offset value. example: 0 paged: type: boolean example: true unpaged: type: boolean example: false totalElements: type: integer description: >- The complete absolute index depth tracking matches globally active. example: 3 totalPages: type: integer description: >- The total volume allocation calculation matching sizes requirements. example: 1 last: type: boolean description: >- Indicates if page frame execution sequence finishes iteration structure bounds. example: true numberOfElements: type: integer description: >- Actual item total populated within the immediate payload snapshot content space. example: 3 first: type: boolean description: >- Indicates if page execution frame occupies the initial block orientation layout index. example: true size: type: integer description: Structural size specification bounds context config indicator. example: 10 number: type: integer description: >- The relative tracking page sequence index identity pointer location wrapper. example: 0 sort: type: object description: Global processing layout configuration indicators. properties: sorted: type: boolean example: true unsorted: type: boolean example: false empty: type: boolean example: false empty: type: boolean description: >- Conditional summary verifying zero matches successfully pulled back. example: false securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Payaza {{Public API Key in Base 64}} TenantID: type: apiKey in: header name: X-TenantID description: live or test ProductID: type: apiKey in: header name: X-ProductID description: 'default value is ‟app” ' ````