Skip to main content
GET
List Invoices

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100
ids
string[]

Filter by invoice IDs. Repeat param for multiple: ?ids=&ids=

reference_ids
string[]

Filter by invoice reference IDs. Repeat param for multiple: ?reference_ids=INV-1&reference_ids=INV-2

Maximum array length: 255
sort_by
enum<string>
Available options:
created_at,
updated_at
sort
enum<string>
Available options:
asc,
desc
status
enum<string>
Available options:
PAID,
PENDING
invoice_statuses
string[]

Filter by lifecycle status. Repeat param for multiple: ?invoice_statuses=SENT&invoice_statuses=OVERDUE

Response

OK

data
object[]
pagination
object