Create a billing meter event

Billing

Meter Events

Creates a billing meter event.

Parameters

event_namestringRequired
The name of the meter event. Corresponds with the event_name field on a meter.

payloadobjectRequired
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.

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.

POST /v1/billing/meter_events

Server-side language

curl https://api.stripe.com/v1/billing/meter_events \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d event_name=ai_search_api \
  -d "payload[value]"=25 \
  -d "payload[stripe_customer_id]"=cus_NciAYcXfLnqBoz \
  -d identifier=identifier_123

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
}

Create a billing meter event

Parameters

event_namestringRequired

payloadobjectRequired

identifierstring

timestamptimestamp

Returns