SDK ReferenceTypeScript SDK

Usage

Billing-period and daily usage breakdowns.

Usage

Billing-period and daily usage breakdowns. Accessed via client.usage.

get

client.usage.get(requestOptions?: RequestOptions): Promise<GetUsageResponse>

GET /v1/usage — get current billing period usage.

requestOptions carries the CLIENT-side abort budget (requestTimeoutMs) and an optional caller signal; both override the constructor's timeoutMs default.

daily

client.usage.daily(params?: GetUsageDailyParams, requestOptions?: RequestOptions): Promise<GetUsageDailyResponse>

GET /v1/usage/daily — get daily usage breakdown. Default range is the last 30 days; max range is 366 days.

byEndpoint

client.usage.byEndpoint(params?: GetUsageByEndpointParams, requestOptions?: RequestOptions): Promise<GetUsageByEndpointResponse>

GET /v1/usage/by-endpoint — get per-endpoint bandwidth breakdown. Default range is the last 30 days; max range is 366 days.