Skip to main content
GET
List invoices
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

subscription_id
string<uuid>

Filter by the internal Kelviq subscription ID.

customer_id
string

Filter by the client-defined unique identifier of the customer.

page_size
integer

Number of results per page. Defaults to 10, maximum 100.

Required range: 1 <= x <= 100
page
integer

Page number to return.

Required range: x >= 1

Response

200 - application/json

A paginated list of invoices.

count
integer
Example:

1

next
string<uri> | null
Example:

null

previous
string<uri> | null
Example:

null

results
object[]