Meter Event Summary

A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.

Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.

Was this section helpful? Yes No

List billing meter event summaries

GET / v1 / billing / meters /:id / event_summaries

The Meter Event Summary object

Attributes

id string Unique identifier for the object.
object string, value is "billing.meter_event_summary" String representing the object’s type. Objects of the same type share the same value.
aggregated _ value number Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via default_aggregation.
end _ time timestamp End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
meter string The meter associated with this event summary.
start _ time timestamp Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.

The Meter Event Summary object

{ "id": "mtrusg_test_6041CMAXJrFdZ56U76ce6L35Hz7xA3Tn58z5sY7bq6gM3XN5bx5Y459D4Xt2E17ko6M86kt7kV3bl5PM7LV59l4sY50b6oU5QD7bY3HP58z5sY7bq6gM3Y57LF2Dr7od3Hb8927gh4Tt4Lo4xO4ge60T81C6Y53gl4QS2D33ft3HC3Xi3Cy3Cy3Cy", "object": "billing.meter_event_summary", "aggregated_value": 10, "end_time": 1711659600, "livemode": false, "meter": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA", "start_time": 1711656000}

List billing meter event summaries

GET / v1 / billing / meters /:id / event_summaries

Retrieve a list of billing meter event summaries.

Parameters

customer string Required The customer for which to fetch event summaries.
end _ time timestamp Required The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
id string Required Unique identifier for the object.
start _ time timestamp Required The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
value _ grouping _ window enum 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). Possible enum values day Generate event summaries per day. hour Generate event summaries per hour.

More parameters

ending _ before string
limit integer
starting _ after string

Returns

Returns a list of billing meter event summaries.

Response