The Meter Event Adjustment object
Attributes
- object string, value is "billing.meter_event_adjustment" String representing the object’s type. Objects of the same type share the same value.
- cancel nullable object Specifies which event to cancel.
- event _ name string The name of the meter event. Corresponds with the
event_namefield on a meter. The maximum length is 100 characters. - livemode boolean If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - status enum The meter event adjustment’s status. Possible enum values
completeThe event adjustment has been processed.pendingThe event adjustment is still being processed. - type enum 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
cancelCancel a single meter event by identifier.
The Meter Event Adjustment object
{ "object": "billing.meter_event_adjustment", "livemode": false, "status": "pending", "event_name": "ai_search_api", "type": "cancel", "cancel": { "identifier": "identifier_123" }}
Create a billing meter event adjustment
POST / v1 / billing / meter_event_adjustments
Creates a billing meter event adjustment.
Parameters
- event _ name string Required The name of the meter event. Corresponds with the
event_namefield on a meter. The maximum length is 100 characters. - type enum Required 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
cancelCancel a single meter event by identifier. - cancel object Specifies which event to cancel.
Returns
Returns a billing meter event adjustment.
Response
{ "object": "billing.meter_event_adjustment", "livemode": false, "status": "pending", "event_name": "ai_search_api", "type": "cancel", "cancel": { "identifier": "identifier_123" }}
