Create a billing meter

POST / v1 / billing / meters

Creates a billing meter.

Parameters

default _ aggregation object Required The default settings to aggregate a meter’s events with.
display _ name string Required The meter’s name. Not visible to the customer. The maximum length is 250 characters.
event _ name string Required The name of the meter event to record usage for. Corresponds with the event_name field on meter events. The maximum length is 100 characters.
customer _ mapping object Fields that specify how to map a meter event to a customer.
event _ time _ window enum The time window which meter events have been pre-aggregated for, if any. Possible enum values day Events are pre-aggregated in daily buckets. hour Events are pre-aggregated in hourly buckets.
value _ settings object Fields that specify how to calculate a meter event’s value.

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": 1704824589, "value_settings": { "event_payload_key": "value" }}

Update a billing meter

POST / v1 / billing / meters /:id

Updates a billing meter.

Parameters

display _ name string The meter’s name. Not visible to the customer. The maximum length is 250 characters.

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": "Updated Display Name", "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" }}

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" }}