Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Billing

List invoices

List invoices based on the specified filters.

The expand option can be used to include additional information (besides the invoice header and totals) in the response. For example by adding the expand=lines option the invoice lines will be included in the response.

Gathering invoices will always show the current usage calculated on the fly.

get/api/v1/billing/invoices

Query parameters

statusesInvoiceStatus[]

Filter by the invoice status.

extendedStatusesstring[]

Filter by invoice extended statuses

issuedAfterstring date-time
Example:2023-01-01T01:01:01.001Z

Filter by invoice issued time. Inclusive.

issuedBeforestring date-time
Example:2023-01-01T01:01:01.001Z

Filter by invoice issued time. Inclusive.

periodStartAfterstring date-time
Example:2023-01-01T01:01:01.001Z

Filter by period start time. Inclusive.

periodStartBeforestring date-time
Example:2023-01-01T01:01:01.001Z

Filter by period start time. Inclusive.

createdAfterstring date-time
Example:2023-01-01T01:01:01.001Z

Filter by invoice created time. Inclusive.

createdBeforestring date-time
Example:2023-01-01T01:01:01.001Z

Filter by invoice created time. Inclusive.

expandInvoiceExpand[]

What parts of the list output to expand in listings

customersstring[]

Filter by customer ID

[
  "01G65Z755AFWAKHE12NY0CQ9FH"
]
includeDeletedboolean

Include deleted invoices

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

The order direction.

orderBy'customer.name' | 'issuedAt' | 'status' | 'createdAt' | 'updatedAt' | 'periodStart'

InvoiceOrderBy specifies the ordering options for invoice listing.

The order by field.

Response

The request has succeeded.

totalCountinteger required

The total number of items.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.