Sample - Stripe API
GET/v1/billing/meters/{id}

Retrieve a billing meter

Retrieves a billing meter by its unique identifier. Use id to select the meter and expand to include expanded response fields. The response contains the meter's event configuration, aggregation settings, lifecycle status, and timestamps.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the billing meter. Maximum 5,000 characters.
expandarray<string>optional
Fields to expand in the response. Each field name can contain up to 5,000 characters.

2 status codes
200Returns the billing meter with its identifier, display name, event configuration, aggregation settings, lifecycle status, timestamps, and value settings.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
customer_mappingobjectrequired
default_aggregationobjectrequired
display_namestringrequired
The meter's name.
event_namestringrequired
The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
event_time_windowstringoptional
The time window which meter events have been pre-aggregated for, if any.
Allowed:dayhour
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:billing.meter
statusstringrequired
The meter's status.
Allowed:activeinactive
status_transitionsobjectrequired
updatedintegerrequired
Time at which the object was last updated. Measured in seconds since the Unix epoch.
value_settingsobjectrequired
defaultError response.
errorobjectrequired

Error handling

id must identify an existing billing meter and must not exceed 5,000 characters. Each value in expand must not exceed 5,000 characters.