Skip to main content
POST
List usage records

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Usage record filter

currency
string
customer_external_id
string
customer_id
string
end_time
string<date-time>
expand
string
filters
object[]

Generic predicate and ordering escape hatch, for comparisons that have no dedicated field below — a range such as period_end at or after a cutoff goes here.

limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
period_end
string<date-time>
period_start
string<date-time>

Exact-match on the window boundaries. Together with SubscriptionID these identify a single row: they are the columns the table's unique index is built on.

plan_id
string
sort
object[]
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
subscription_id
string
synced
boolean

Response

OK

items
object[]
pagination
object