v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB

Invoices

Get a list of invoices

Retrieves a cursor-paginated list of a customer's invoices, fetched live from the connected billing provider. Ordered by issue date ascending by default; override with orderBy (issueDate | dueDate | total) and orderDir (ASC | DESC). Optionally narrowed to one contract, an issue-date range, and/or a set of invoice states. Returns an empty list when no billing provider is connected or the customer is not synced.

get/api/v1/customers/{id}/invoices

Path parameters

idstring required

External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID

Query parameters

limitinteger

Maximum number of items to return

afterstring

Return items that come after this cursor

beforestring

Return items that come before this cursor

contractExternalIdstring

Filter to invoices for this contract only (contract external ID or Received contract ID). Omit for all contracts.

stateInstring

Filter by invoice state. Supports comma-separated values for multiple states

issuedAfterstring date-time

Filter to invoices issued on or after this date, inclusive (ISO 8601)

issuedBeforestring date-time

Filter to invoices issued on or before this date, inclusive (ISO 8601)

orderBy'issueDate' | 'dueDate' | 'total'

Field to sort by: issueDate (default), dueDate, or total

orderDir'ASC' | 'DESC'

Sort direction: ASC (default) or DESC

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

A cursor-paginated list of the customer's invoices.