API Reference
SUPPORT CENTREEZYPAY

List invoices

get
https://api-sandbox.ezypay.com/v2/billing/invoices

This API Endpoint allows integrators to retrieve a list of invoice depending on the filter criteria of their choice. The allowed filters are highlighted in the "QUERY PARAM" below.

By default a maximum of 10 invoice will be return if the limit is not specify. This invoices will be returned in sorted by creation date, with the most recently created invoices appearing at the top of the list.

All Invoice shown will only be invoices belonging to the merchant Id provided.

NOTE: If the filter provided is not found, the list provided will be the same as a list of invoice without any filter condition.

Query Params
string

Filter by unique identifier of the customer.

string

Filter by unique identifier of the subscription.

string

Filter by unique identifier of the externalInvoiceId from integrator's system.

string

Filter by invoice status. Supported values are PAID, PENDING, PROCESSING, PAST_DUE,UNPAID, REFUNDED, PARTIALLY_REFUNDED and WRITTEN_OFF.

string

Start date for range of invoices to view. Filter by date defined in the invoice date.

string

Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.

string

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

string

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

string

Filter by unique identifier of a checkout session (not the same as the session hash).

Headers
string
required

Merchant ID

Responses

Updated 5 months ago

Language
Response 
 Choose an example:
application/json
Updated 5 months ago