Skip to main content
GET
List invoices

Query Parameters

Example Request

Response

Errors

See Errors for the error envelope and the full code taxonomy.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Query Parameters

customer_id
string<uuid>

Filter to one customer's invoices (tenant-scoped; a foreign customer id yields an empty page).

subscription_id
string<uuid>

Filter to one subscription's invoices (tenant-scoped). Ignored when customer_id is also provided.

q
string

Case-insensitive substring search on invoice_number (tenant-scoped), newest first. Backs the command-palette invoice lookup. Ignored when customer_id or subscription_id is provided.

page
integer
default:1

1-based page number.

Required range: x >= 1
per_page
integer
default:50

Records per page (capped at 250).

Required range: 1 <= x <= 250
limit
integer

Alias of per_page (default 50, max 250); when both are sent limit wins.

Required range: 1 <= x <= 250
offset
integer

Row offset (default 0). Overrides the offset computed from page.

Required range: x >= 0

Response

Invoices for the tenant.

data
object[]