Skip to content
Hardcount
Run it locally
Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →

Discard held usage

POST
/v1/usage-events/held/discard
curl --request POST \
  --url http://localhost:8080/v1/usage-events/held/discard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "external_customer_id": "example", "event_name": "example" }'

Marks the held rows for one external customer ID (and one event name, when given) as discarded. They are never billed. The rows stay stored as a record. Writes an audit log entry. Requires usage write permission.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
external_customer_id
required
string
event_name

Discard only the rows with this event_name. Omit for all.

string

Example generated

{
  "external_customer_id": "example",
  "event_name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Rows discarded

Media typeapplication/json
object
discarded
required
integer

Example generated

{
  "discarded": 1
}

422

Section titled “422”

validation_error: external_customer_id is missing, or the body has an unknown field (param names it; the body must use only the fields listed here).

Media typeapplication/json
object
error
object
type

One of invalid_request_error, authentication_error, rate_limit_error or api_error. Every error the API answers has this shape, including an unknown path (404, code route_not_found) and a method the path does not take (405, code method_not_allowed, with an Allow header). The few exceptions are listed in docs/api-surface.md.

string
code
string
message
string
request_id
string
param

The request field the error is about. Sent only when the error names one. A request body may hold only the fields its operation lists, spelled and cased as listed: any other field, or one the server sets (such as id), is refused with 422 and param naming it. An operation with no request body lists no fields: send no body, {} or null. The Stripe and Postmark webhooks and the LiteLLM callback take their sender’s body as it comes.

string

Example 

{
  "error": {
    "type": "invalid_request_error"
  }
}