Skip to main content
GET
List orders
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

Search by order ID, customer name, email, or customer ID.

status
enum<string>

Filter by order status.

Available options:
PENDING,
COMPLETE,
FAILED,
REFUNDED,
PARTIAL_REFUND,
CANCELLED,
FRAUDULENT
billing_type
enum<string>

Filter by billing type.

Available options:
ONE_TIME,
SUBSCRIPTION
is_renewal
boolean

Filter by whether the order is a recurring renewal charge (true) versus an initial sign-up/one-time purchase (false).

start_date
string<date>

Include orders paid on or after this date.

end_date
string<date>

Include orders paid on or before this date.

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

A paginated list of orders.

count
integer
Example:

1

next
string<uri> | null
Example:

null

previous
string<uri> | null
Example:

null

results
object[]