Usage summary for the period

GET 
/v1/usage/summary

Returns the aggregated usage of a subscription item for the current billing period (or for an arbitrary period via period_start/period_end). Honors set records (which replace) and the sum of subsequent increment records. When the price is tiered or per-unit, computes an estimated cost in estimated_cost (float, up to 4 decimal places).

Request

Responses

200

Usage summary, period and estimated cost.

400

Request body failed validation.

401

Missing or invalid bearer token.

403

Token is valid but lacks permission for this operation. With code insufficient_scope, details.required carries the one minimal set of scopes that, added to details.granted, would let the request through: the resource scope (billing/{resource}, or billing/all off the catalogue) then the bare verb — e.g. ["billing/customers", "delete"].

404

Resource not found in the current organization.

429

Rate limit exceeded.

500

Unexpected server error.