Skip to main content
GET
Billing Events

Authorizations

Authorization
string
header
required

Admin API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_ADMIN_API_KEY

Query Parameters

limit
integer

Maximum number of items to return. Actual maximum depends on query type and expansion parameters.

Required range: x >= 1
Example:

50

cursor
string

Pagination cursor from previous response. Encodes the page number.

Example:

"Mg=="

start

Start date in ISO8601 format (e.g., '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.

Example:

"2025-01-01T00:00:00Z"

end

End date in ISO8601 format, exclusive (e.g., '2025-02-01T00:00:00Z' or '2025-02-01'). Data up to but not including this timestamp is returned. Defaults to current time.

Example:

"2025-02-01T00:00:00Z"

endpoint_id

Filter by specific endpoint ID(s). Accepts 1-50 endpoint IDs. Supports comma-separated values: ?endpoint_id=model1,model2 or array syntax: ?endpoint_id=model1&endpoint_id=model2

Example:
request_id

Filter by specific request ID(s). Accepts 1-50 request IDs. Supports comma-separated values: ?request_id=req1,req2 or array syntax: ?request_id=req1&request_id=req2

Example:
expand

Data to include in the response. Use 'auth_method' to include authentication method information (formatted with user key aliases).

Example:

"auth_method"

Response

Billing event data retrieved successfully

Response containing billing event data with pagination support

next_cursor
string | null
required

Cursor for the next page of results, null if no more pages

has_more
boolean
required

Boolean indicating if more results are available (convenience field derived from next_cursor)

billing_events
object[]
required

List of billing event records