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.
queryobjectRequired
The query value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
entitlementIduuidRequired
The entitlementId value for this operation. Its accepted type and constraints are listed above and below.
entityIduuid | nullRequired
Entity ID within the current customer scope, for configured entity and license features.
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"
usageobjectRequired
The usage value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
entitlementIduuidRequired
The entitlementId value for this operation. Its accepted type and constraints are listed above and below.
entityIduuid | nullRequired
Entity ID within the current customer scope, for configured entity and license features.
operationIduuid | nullRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
usageobjectRequired
The usage value for this operation. Its accepted type and constraints are listed above and below.
capacitystring | nullRequired
The capacity value for this operation. Its accepted type and constraints are listed above and below.
remainingstring | nullRequired
Remaining allowance at evaluation time. It is not reserved and does not guarantee later consumption.
withinLimitbooleanRequired
The withinLimit value for this operation. Its accepted type and constraints are listed above and below.
revisionintegerRequired
Revision returned by profile reads; updates use it to detect concurrent changes.
min: 0 · max: 9007199254740991
updatedAtdate-time | nullRequired
ISO 8601 UTC time of the last record update.
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery
Verify the key or refresh the expired customer token once.
FORBIDDEN
Recovery
Check current key permissions and customer access.
INVALID_REQUEST
Recovery
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Recovery
Use the App and environment bound to the credential.