Create a billing meter event adjustment

Creates a billing meter event adjustment.

Parameters

  • event_namestringRequired

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

    The maximum length is 100 characters.

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

  • cancelobject

    Specifies which event to cancel.

Returns

Returns a billing meter event adjustment.

POST /v1/billing/meter_event_adjustments
curl https://api.stripe.com/v1/billing/meter_event_adjustments \
-u "sk_test_Gx4mWEg...4DYMUIqfIrszsk_test_Gx4mWEgHtCMr4DYMUIqfIrsz:" \
-d type=cancel \
-d event_name=ai_search_api \
-d "cancel[identifier]"=identifier_123
Response
{
"object": "billing.meter_event_adjustment",
"livemode": false,
"status": "pending",
"event_name": "ai_search_api",
"type": "cancel",
"cancel": {
"identifier": "identifier_123"
}
}