List Invoices

List all invoices with pagination, filtering, and sorting options.

include_paymentsboolean nullable

payment_link_idstring uuid nullable

statusesInvoiceStatusEnum[] nullable

payment_statusesPaymentStatusEnum[] nullable

Invoice includes payments with the following statuses

search_termstring nullable

from_datestring date-time nullable

to_datestring date-time nullable

due_date_fromstring date-time nullable

Invoice's payment due date from this date onwards

due_date_tostring date-time nullable

Invoice's payment due date to this date or older

number

OR

string

number

OR

string

organization_consumer_idstring uuid4 nullable

subscription_idstring uuid4 nullable

metered_subscription_idstring uuid4 nullable

currenciesstring nullable

Filter by invoice currency codes (OR). E.g. currencies=SAR,USD

payments_not_settledboolean nullable

When true, only include invoices with a SUCCEEDED card/wallet payment (e.g. MADA, Visa).

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Response

Successful Response