Create a billing meter event adjustment v2

Creates a meter event adjustment to cancel a previously sent meter event.

Learn more about calling API v2 endpoints.

Parameters

cancelobjectRequired
Specifies which event to cancel.

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

typeenumRequired
Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
Possible enum values
cancel
Cancel a single meter event by identifier.

Returns

Response attributes

idstring
The unique id of this meter event adjustment.

objectstring, value is "v2.billing.meter_event_adjustment"
String representing the object’s type. Objects of the same type share the same value of the object field.

cancelobject
Specifies which event to cancel.

createdtimestamp
The time the adjustment was created.

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

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

statusenum
The meter event adjustment’s status.
Possible enum values
complete
The event adjustment has been processed.
pending
The event adjustment is still being processed.

typeenum
Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
Possible enum values
cancel
Cancel a single meter event by identifier.

Error Codes

400invalid_cancel_configuration

The adjustment configuration is invalid for the adjustment type.

POST /v2/billing/meter_event_adjustments

Server-side language

curl -X POST https://api.stripe.com/v2/billing/meter_event_adjustments \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-06-30.preview" \
  --json '{
    "event_name": "ai_search_api",
    "type": "cancel",
    "cancel": {
        "identifier": "idmp_12345678"
    }
  }'

Response

{
  "object": "v2.billing.meter_event_adjustment",
  "id": "mtr_event_adj_12345678",
  "livemode": false,
  "created": "2024-06-01T12:00:00.000Z",
  "status": "pending",
  "event_name": "ai_search_api",
  "type": "cancel",
  "cancel": {
    "identifier": "idmp_12345678"
  }
}

Meter Event Streams v2

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.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/billing/meter_event_session

POST/v2/billing/meter_event_stream

Meter Event Summary

A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.

Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.

Endpoints

GET/v1/billing/meters/:id/event_summaries