Create a billing meter event 

Billing
Meter Events
Create a billing meter event

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 will be generated. We recommend using a globally unique identifier for this. We’ll enforce uniqueness within a rolling 24 hour period.

  • 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
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
}