The Meter Event object

Attributes

• object (string, value is "v2.billing.meter_event") String representing the object’s type. Objects of the same type share the same value of the object field.

• created (timestamp) The creation time of this meter event.

• event_name (string) The name of the meter event. Corresponds with the event_name field on a meter.

• identifier (string) A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We’ll enforce uniqueness within a rolling 24 hour period.

• livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• payload (map) 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…

• timestamp (timestamp) The time of the event. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.

The Meter Event object

{
  "object": "v2.billing.meter_event",
  "created": "2024-06-01T12:10:00.000Z",
  "livemode": false,
  "identifier": "idmp_12345678",
  "event_name": "ai_search_api",
  "timestamp": "2024-06-01T12:00:00.000Z",
  "payload": {
    "stripe_customer_id": "cus_12345678",
    "value": "25"
  }
}