List all invoices
This endpoint is used for retrieving all invoices.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page number.
1
Number of records per page.
20
Unique identifier assigned to the customer in your application.
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
9000
Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.
100000
Filter invoices starting from a specific date.
"2022-07-08"
Filter invoices up to a specific date.
"2022-08-09"
Filter invoices by status. Possible values are draft
or finalized
.
draft
, finalized
Filter invoices by payment status. Possible values are pending
, failed
or succeeded
.
pending
, failed
, succeeded
Filter invoices by payment_overdue. Possible values are true
or false
.
true
Search invoices by id, number, customer name, customer external_id or customer email.
"Jane"
Filter invoices by currency. Possible values ISO 4217 currency codes.
"EUR"
Filter invoices with a payment dispute lost. Possible values are true
or false
.
true
Filter invoices by invoice type. Possible values are subscription
, add_on
, credit
, one_off
, advance_charges
or progressive_billing
.
subscription
, add_on
, credit
, one_off
, advance_charges
, progressive_billing
Filter invoices by self billed. Possible values are true
or false
.
true
Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.
["acme_corp", "foo_bar"]
Filter invoices by metadata. Replace key
with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, metadata[color]=blue
.
"someValue"
Response
The response is of type object
.