The Meter Event object

Attributes

object string, value is "billing.meter_event" String representing the object’s type. Objects of the same type share the same value.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
event _ name string The name of the meter event. Corresponds with the event_name field on a meter. The maximum length is 100 characters.
identifier string A unique identifier for the event.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
payload map The payload of the event. This contains the fields corresponding to a meter’s customer_mapping.event_payload_key (default is stripe_customer_id) and value_settings.event_payload_key (default is value). Read more about the payload.
timestamp timestamp The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.

{ "object": "billing.meter_event", "created": 1704824589, "event_name": "ai_search_api", "identifier": "identifier_123", "livemode": true, "payload": { "value": "25", "stripe_customer_id": "cus_NciAYcXfLnqBoz" }, "timestamp": 1680210639}

Create a billing meter event

POST / v1 / billing / meter_events

Creates a billing meter event.

Parameters

event _ name string Required The name of the meter event. Corresponds with the event_name field on a meter. The maximum length is 100 characters.
payload map Required The payload of the event. This must contain the fields corresponding to a meter’s customer_mapping.event_payload_key (default is stripe_customer_id) and value_settings.event_payload_key (default is value). Read more about the payload.
identifier string A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. Stripe enforces uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. The maximum length is 100 characters.
timestamp timestamp The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.

Returns

Returns a billing meter event.

Response

{ "object": "billing.meter_event", "created": 1704824589, "event_name": "ai_search_api", "identifier": "identifier_123", "livemode": true, "payload": { "value": "25", "stripe_customer_id": "cus_NciAYcXfLnqBoz" }, "timestamp": 1680210639}