The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
customerIduuidOptional
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
commandobjectRequired
The command value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
operation"quote"Required
The operation value for this operation. Its accepted type and constraints are listed above and below.
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"
entitlementIduuidRequired
The entitlementId value for this operation. Its accepted type and constraints are listed above and below.
entityIduuidOptional
Entity ID within the current customer scope, for configured entity and license features.
quantitystringRequired
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.
pattern: ^(0|[1-9]\d{0,11})(\.\d{1,6})?$
propertiesobjectRequired
Validated pricing properties used to match dimensions and multipliers.
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"
quoteobjectRequired
The quote value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
allowedbooleanRequired
Whether this feature is allowed at evaluation time. Use for display; your backend still authorizes business operations.
entitlementIduuidRequired
The entitlementId 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"
reasonenum | nullRequired
Rejection reason or ledger operation description; interpret with accepted and status.
allocationsarrayRequired
Balance allocations involved in this evaluation or ledger operation.