Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.
Attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- event_
namestring The name of the meter event. Corresponds with the
event_field on a meter.name The maximum length is 100 characters.
- identifierstring
A unique identifier for the event.
- livemodeboolean
If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - payloadobject
The payload of the event. This contains the fields corresponding to a meter’s
customer_(default ismapping. event_ payload_ key stripe_) andcustomer_ id value_(default issettings. event_ payload_ key value). Read more about the payload. - timestamptimestamp
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}Creates a billing meter event.
Parameters
- event_
namestringRequired The name of the meter event. Corresponds with the
event_field on a meter.name The maximum length is 100 characters.
- payloadobjectRequired
The payload of the event. This must contain the fields corresponding to a meter’s
customer_(default ismapping. event_ payload_ key stripe_) andcustomer_ id value_(default issettings. event_ payload_ key value). Read more about the payload. - identifierstring
A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce 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.
- timestamptimestamp
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.
{ "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}