Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Use a Bouclay secret key (sk_test_..., sk_live_...) or restricted key (rk_test_..., rk_live_...).

A secret key can call every endpoint. A restricted key can only call the endpoints its scopes cover. A scope is {resource}:{access}, for example customers:read or refunds:write, and write includes read. GET requests need read access and everything else needs write, except POST /subscriptions/{id}/items/{item}/preview, which only needs subscriptions:read. A request outside the key's scopes gets 403 permission_denied naming the missing scope, and its Idempotency-Key is not used up.

Publishable keys (pk_...) are rejected by server-side API endpoints. A key's mode scopes what it can see and charge: a test key can never reach a live card.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
after
string

Return results after this public ID cursor.

before
string

Return results before this public ID cursor. Cannot be combined with after.

status
string
customerId
string
subscriptionId
string

Response

200 - application/json

Invoice list response.

data
object[]
required
meta
object
required