v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

List billing meter event summaries

Retrieve a list of billing meter event summaries.

get/v1/billing/meters/{id}/event_summaries

Path parameters

idstring required

Unique identifier for the object.

Query parameters

customerstring required

The customer for which to fetch event summaries.

end_timeinteger required

The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

start_timeinteger required

The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

value_grouping_window'day' | 'hour'

Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.