Retrieve a billing meter

GET / v1 / billing / meters /:id

Retrieves a billing meter given an ID.

Parameters

No parameters.

Returns

Returns a billing meter.

Response

{ "id": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA", "object": "billing.meter", "created": 1704824589, "customer_mapping": { "type": "by_id", "event_payload_key": "stripe_customer_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "Search API Calls", "event_name": "ai_search_api", "event_time_window": null, "livemode": false, "status": "active", "status_transitions": { "deactivated_at": null }, "updated": 1704898330, "value_settings": { "event_payload_key": "value" }}

List billing meters

GET / v1 / billing / meters

Retrieve a list of billing meters.

Parameters

status enum Filter results to only include meters with the given status. Possible enum values active The meter is active. inactive The meter is inactive. No more events for this meter will be accepted. The meter cannot be attached to a price.

More parameters

ending _ before string
limit integer
starting _ after string

Returns

Returns a list of billing meters.

Response

Deactivate a billing meter

POST / v1 / billing / meters /:id / deactivate

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Parameters

No parameters.

Returns

Returns a billing meter.

Response

{ "id": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA", "object": "billing.meter", "created": 1704824589, "customer_mapping": { "type": "by_id", "event_payload_key": "stripe_customer_id" }, "default_aggregation": { "formula": "sum" }, "display_name": "Search API Calls", "event_name": "ai_search_api", "event_time_window": null, "livemode": false, "status": "active", "status_transitions": { "deactivated_at": 1704898330 }, "updated": 1704898330, "value_settings": { "event_payload_key": "value" }}