A trusted server consumes usage for features mapped to eventName or for a specific internal_feature_id and returns balance receipts. Choose one target type. Retries reuse the original idempotency key and receipts; inspect each receipt's accepted status.
API v1Updated
Make the request
A trusted server consumes usage for features mapped to eventName or for a specific internal_feature_id and returns balance receipts. Choose one target type. Retries reuse the original idempotency key and receipts; inspect each receipt's accepted status.
Credential
Server API key only. Call from your trusted backend.
Permission
credits:consume
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
customerIduuidRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
commandobject | objectRequired
The command value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
eventNamestringOptional
The eventName value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1
quantitystring | stringOptional
Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.
propertiesobject | objectOptional
Validated pricing properties used to match dimensions and multipliers.
entityIduuid | uuidOptional
Entity ID within the current customer scope, for configured entity and license features.
idempotencyKeystring | stringRequired
Stable business idempotency key. The same key and payload replay the result; do not randomize on retries.
internal_feature_iduuidOptional
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
receiptsarrayRequired
The receipts value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
internal_feature_iduuidRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
kindenumRequired
The kind value for this operation. Its accepted type and constraints are listed above and below.
The originalId value for this operation. Its accepted type and constraints are listed above and below.
quantityobjectRequired
Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.
requestedQuantityobjectOptional
Original quantity for explicit cap/overflow. quantity is the quantity accepted or rejected by the operation.
overageBehaviorenumOptional
cap accepts the largest permitted quantity, possibly zero. overflow requests the full quantity subject to overage permission, usage caps and cash budgets. Omission keeps all-or-nothing behavior.
Show allowed values
"cap""overflow"
acceptedbooleanRequired
Whether business rules accepted the operation. HTTP 200 does not imply accepted is true.
reasonenum | nullRequired
Rejection reason or ledger operation description; interpret with accepted and status.
createdAtdate-timeRequired
ISO 8601 UTC time when the record was created.
reservationStatusenum | nullRequired
The reservationStatus value for this operation. Its accepted type and constraints are listed above and below.
expiresAtdate-time | nullRequired
ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
allocationsarrayRequired
Balance allocations involved in this evaluation or ledger operation.