Meter Event Adjustments v2

A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.

Learn more about calling API v2 endpoints.

Was this section helpful? Yes No

Create a Meter Event Adjustment

POST / v2 / billing / meter_event_adjustments

The Meter Event Adjustment object v2

Attributes

• id string The unique ID of this meter event adjustment.
• object string, 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.
• cancel object Specifies which event to cancel.
• created timestamp The time the adjustment was created.
• event _ name string The name of the meter event. Corresponds with the event_name field on a meter.
• livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• status enum The meter event adjustment’s status. Possible enum values complete The event adjustment has been processed. pending The event adjustment is still being processed.
• type enum Specifies the type of cancellation. Currently supports canceling a single event. Possible enum values cancel Cancel a single meter event by identifier.

The Meter Event Adjustment object

{ "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" }}

Create a Meter Event Adjustment v2

POST / v2 / billing / meter_event_adjustments

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

Learn more about calling API v2 endpoints.

Parameters

• cancel object Required Specifies which event to cancel.
• event _ name string Required The name of the meter event. Corresponds with the event_name field on a meter.
• type enum Required Specifies the type of cancellation. Currently supports canceling a single event. Possible enum values cancel Cancel a single meter event by identifier.

Returns

Returns a Meter Event Adjustment object.

Error Codes

400 invalid _ cancel _ configuration

The adjustment configuration is invalid for the adjustment type.

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