Organization

List usage events

Usage events newest first, one opaque-cursor page at a time, each with its cost and settlement state; the transactions that paid an event live on the single-event lookup.

GET /organization/v1/events● Supported

Official reference ↗

Request parameters

  • starting_atstring必填

    query: Window start (inclusive), UTC ISO 8601, e.g. 2026-09-26T00:00:00Z

  • ending_atstring必填

    query: Window end (exclusive), UTC ISO 8601; at most 93 days after starting_at (the charges export has no such cap)

  • limitinteger可选

    query: Page size, 1–100, defaults to 25

  • pagestring可选

    query: The opaque cursor from the previous page's next_page — pass it back unchanged

Returns

200 page

Errors follow the problem+json format — see error codes

Response

HTTP 200

Event page

application/json

NameTypeDescription
objectstringObject type; always `page`.
dataarray<object>Usage events, newest first.
data[].objectstringObject type; always `usage.event`.
data[].idstringId of the usage event; pass it to getOrganizationEvent.
data[].occurred_atstringTime at which the usage happened, UTC.
data[].ServiceNamestringName of the platform service that produced the usage (the source service of the usage event).
data[].ServiceCategorystringCategory of the service; a service without a registered category reports its own name.
data[].ResourceIdstringId of the resource that the usage belongs to.
data[].ResourceNamestringDisplay name of the resource; falls back to ResourceId when no name is known.
data[].BilledCoststringAmount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles.
data[].BillingCurrencystringCurrency of BilledCost; always `USD`.
data[].ChargeClassstring | null`Correction` for an event that corrects an earlier charge (its BilledCost is negative); null for ordinary usage.
data[].request_idstring | nullX-Request-Id of the API call that produced the usage; null for usage that does not come from a request.
data[].settlementobjectHow the usage was charged: settlement state, any shortfall, and why nothing was charged.
data[].linesarray<object>Metering lines mapped from the billing measurements; the priced split (ListUnitPrice, PricingUnit, BilledCost) rides only GET /events/{id}.
has_morebooleanWhether more results exist beyond this page; request again with `page` set to `next_page` to read them.
next_pagestring | nullOpaque cursor for the next page; null on the last page. Pass it unchanged as `page`.

Response fields

FieldDescription
objectalways "page"
data[].objectalways "usage.event"
data[].idThe event id — use it for the single-event lookup and reconciliation
data[].occurred_atWhen the usage happened (UTC)
data[].ServiceName / ServiceCategory / ResourceId / ResourceNameFOCUS service and resource columns
data[].BilledCost / BillingCurrencyThe event's cost (decimal string) and the currency charged (CNY or USD)
data[].ChargeClass"Correction" for correction events (negative cost), null otherwise
data[].request_idThe X-Request-Id of the API call that produced this usage — look it up in your call logs
data[].settlement.statussettled (charged) / no_charge (recorded, nothing charged) / rejected (billing refused the charge)
data[].settlement.shortfall / data[].settlement.zero_reasonCurrently always null; reserved for later settlement detail
has_more / next_pageNewest first, one cursor page at a time; pages never duplicate or skip an event

For the transactions behind one event see Get a usage event.