Skip to navigation
API ReferenceBilling

List Invoices

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1
Page number
sizeintegerOptional1-100Defaults to 20
Page size
searchstring or nullOptional<=200 characters
statusstring or nullOptionalformat: "^(draft|pending|sent|partially_paid|paid|overdue)$"

‘overdue’ is derived (unpaid + past due_date), not a stored status

sort_bystring or nullOptional<=50 characters

Field to sort by; see the resource’s sortable fields

sort_dirstring or nullOptionalformat: "^(asc|desc)$"

Response

Successful Response
itemslist of objects
totalinteger
pageinteger
sizeinteger
pagesintegerRead-only

Errors

422
Unprocessable Entity Error