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.
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_field on a meter.name - livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - statusenum
The meter event adjustment’s status.
Possible enum valuescompleteThe event adjustment has been processed.
pendingThe 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 valuescancelCancel a single meter event by identifier.
{ "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" }}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_field on a meter.name - 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 valuescancelCancel 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_field on a meter.name - livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - statusenum
The meter event adjustment’s status.
Possible enum valuescompleteThe event adjustment has been processed.
pendingThe 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 valuescancelCancel a single meter event by identifier.
The adjustment configuration is invalid for the adjustment type.
{ "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" }}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.
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.