Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Enter your JWT in the format: Bearer {token}

Path Parameters

workspaceId
string
required

The ID of the workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

billingAccountId
string
required

The ID of the billing account, which corresponds to a Stripe Customer ID (cus_...).

Example:

"cus_a1b2c3d4e5f6g7h8"

Query Parameters

limit
integer
default:100

A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 100.

after
string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with inv_..., your subsequent call can include after=inv_... in order to fetch the next page of the list.

before
string

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with inv_..., your subsequent call can include before=inv_... in order to fetch the previous page of the list.

Response

A list of invoice objects.

data
object[]
has_more
boolean
next_cursor
string | null
previous_cursor
string | null