Skip to main content
GET
Usage for one end customer, by feature or day

Authorizations

Authorization
string
header
required

Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys).

Path Parameters

customerId
string
required

Your end-customer id, URL-encoded, exactly as tagged on requests (1–128 printable characters).

Required string length: 1 - 128

Query Parameters

start
string

Inclusive start of the period: a UTC date (2026-10-01) or an RFC 3339 timestamp. Defaults to 30 days before end.

end
string

Exclusive end of the period: a UTC date or an RFC 3339 timestamp. Defaults to now. The period may span at most 92 days.

group_by
enum<string>
default:feature

feature (default) or day.

Available options:
feature,
day

Response

OK

customer_id
string
required
period
object
required

The period the figures cover.

currency
enum<string>
required
Available options:
USD
has_pricing_rules
boolean
required

Whether at least one of your pricing rules applies to the period. When false, billable_usd and margin fields are omitted everywhere.

truncated
boolean
required

True when the period held more rows than one response carries and the cheapest were dropped. Narrow the period or query one customer.

group_by
enum<string>
required
Available options:
feature,
day
groups
object[]
required

Highest cost first for features; chronological for days. Empty for an unknown customer id.

totals
object
required

Sum over the customer's usage in the period.

monthly_flat_charges
object[]
required

Monthly flat fees booked in the period, one per calendar month with matched usage. Already included in billable_usd.