v52

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

Retrieve a billing meter

Retrieves a billing meter given an ID.

get/v1/billing/meters/{id}

Path parameters

idstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

display_namestring required

The meter's name.

event_namestring required

The name of the meter event to record usage for. Corresponds with the event_name field on meter events.

event_time_window'day' | 'hour' nullable

The time window which meter events have been pre-aggregated for, if any.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'billing.meter' required

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

status'active' | 'inactive' required

The meter's status.

updatedinteger required

Time at which the object was last updated. Measured in seconds since the Unix epoch.