Creates a billing meter event.
Parameters
- event_
namestringRequired The name of the meter event. Corresponds with the
event_field on a meter.name - 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.
- 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}Meter Events v2
Meter events are used to report customer usage of your product or service. Meter events are associated with billing meters, which define the shape of the event’s payload and how those events are aggregated. Meter events are processed asynchronously, so they may not be immediately reflected in aggregates or on upcoming invoices.
A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
You can send a higher-throughput of meter events using meter event streams. For this flow, you must first create a meter event session, which will provide you with a session token. You can then create meter events through the meter event stream endpoint, using the session token for authentication. The session tokens are short-lived and you will need to create a new meter event session when the token expires.