v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Credit usage

Get credit usage

Retrieves credit usage time-series data for a customer, grouped by feature, over a specified time range.

get/api/v1/credits/usage

Query parameters

limitinteger

Maximum number of items to return

afterstring

Return items that come after this cursor

beforestring

Return items that come before this cursor

customerIdstring required

Filter by customer ID (required)

resourceIdstring

Filter by resource ID

currencyIdstring

Filter by currency ID

timeRange'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR'

Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults to LAST_MONTH

startDatestring date-time

Start date for the credit usage time range (ISO 8601). Takes precedence over timeRange when provided

endDatestring date-time

End date for the credit usage time range (ISO 8601). Defaults to now when startDate is provided

groupBystring

Comma-separated list of feature dimension keys to group usage series by (up to 3). Each key matches /^[a-zA-Z0-9_$-]+$/

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

Credit usage data with time-series points per feature.