The operation value for this operation. Its accepted type and constraints are listed above and below.
overageBehaviorenum | enumOptional
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.
entitlementIduuid | uuid | uuidOptional
The entitlementId value for this operation. Its accepted type and constraints are listed above and below.
entityIduuid | uuid | uuidOptional
Entity ID within the current customer scope, for configured entity and license features.
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.
Stable business idempotency key. The same key and payload replay the result; do not randomize on retries.
expiresInSecondsintegerOptional
The expiresInSeconds value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 86400
operationIduuid | uuid | uuidOptional
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
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"
receiptobjectRequired
The receipt value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
entitlementIduuidRequired
The entitlementId 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.