Skip to main content
GET
List invoices

Authorizations

X-API-KEY
string
header
required

Query Parameters

clientId
string

Filter by client ID

companyId
string

Filter by company ID. Required with clientId when includeCompanyInvoices is true (returns that client's invoices plus the company's).

includeCompanyInvoices
boolean

When true with clientId, also include invoices billed to companyId. companyId is required in that case.

subscriptionId
string

Filter by subscription ID

limit
integer

Maximum number of records to return

nextToken
string

Pagination cursor returned by a previous request

Response

OK

data
object[] | null

Invoices is the page of invoices matching the query.

nextToken
string

base64 encoded JSON representing a NextToken