Skip to main content
POST
Typescript (SDK)

Body Parameters

Response

Authorizations

Authorization
string
header
required

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

Headers

x-api-version
string
default:2.3.0
required

Body

application/json
start_cursor
string
default:""

Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.

limit
integer
default:50

Number of items to return. Default 50, hard ceiling 5000.

Required range: 1 <= x <= 5000
customer_id
string

Filter invoices to a single customer by ID.

entity_id
string

Filter invoices to a single entity by ID. Must be provided together with customer_id, since entity IDs are only unique per customer.

status
enum<string>[]

Filter by invoice status (draft, open, paid, void, uncollectible).

Available options:
draft,
open,
void,
paid,
uncollectible
processor_types
enum<string>[]

Filter by billing processor (stripe, revenuecat). Invoices recorded before processor tracking count as stripe.

Available options:
stripe,
revenuecat

Response

200 - application/json

OK

list
object[]
required

Items for current page.

next_cursor
string | null
required

Opaque cursor for the next page. Null when there are no more results.