Skip to main content
Use runs.consume while a budgeted workload is running. It applies a synchronous metered event to the run and rejects spend when the run is no longer allowed to consume budget.

Request

string
required
The budgeted run ID.
string
required
The specific feature or entitlement to consume against the running budget.
string
required
Logical key used to deduplicate this run consumption event.
string
Broad event kind configured in Unprice.
string
Optional event ID from your system.
number
Optional epoch-millisecond event timestamp.
object
Event properties used by meters. The targeted feature’s meter reads the relevant field from this object.

Response

boolean
required
Whether the run consumption event was accepted.
string
required
Decision reason. Expected values include accepted, duplicate, insufficient_budget, expired, not_running, and entitlement_denied.
object
required
Current budget run summary after the decision.