This endpoint is used to deprecate a single usage event with a given event_id
. event_id
refers to the
idempotency_key
passed in during ingestion.
This endpoint will mark the existing event as ignored. Note that if you attempt to re-ingest an event with the same
event_id
as a deprecated event, Orb will return an error.
This is a powerful and audit-safe mechanism to retroactively deprecate a single event in cases where you need to:
If you want to only change specific properties of an event, but keep the event as part of the billing calculation, use the Amend event endpoint instead.
This API is always audit-safe. The process will still retain the deprecated event, though it will be ignored for billing calculations. For auditing and data fidelity purposes, Orb never overwrites or permanently deletes ingested usage data.
idempotency_key
with the event in this endpoint, since this request is by design
idempotent. On retryable errors, you should retry the request and assume the deprecation operation has not
succeeded until receipt of a 2xx.timestamp
must fall within the customer’s current subscription’s billing period, or within the
grace period of the customer’s current subscription’s previous billing period. Orb does not allow deprecating
events for billing periods that have already invoiced customers.customer_id
or the external_customer_id
of the original event ingestion request must identify a Customer
resource within Orb, even if this event was ingested during the initial integration period. We do not allow
deprecating events for customers not in the Orb system.API Keys can be issued in the Orb's web application.
OK
The response is of type object
.