The trusted server adjusts available funds or edits the current grant, expiry and next reset. expectedAvailable and expectedRevision reject concurrent changes. Spent and held amounts are retained; the next cycle restores the plan quota and original cadence.
SDK 0.0.1Updated
Make the request
The trusted server adjusts available funds or edits the current grant, expiry and next reset. expectedAvailable and expectedRevision reject concurrent changes. Spent and held amounts are retained; the next cycle restores the plan quota and original cadence.
Credential
Server API key only. Call from your trusted backend.
Permission
credits:manage
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
requestIduuid | uuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
sourceIduuid | uuidRequired
The sourceId value for this operation. Its accepted type and constraints are listed above and below.
expectedAvailablestring | stringRequired
The expectedAvailable value for this operation. Its accepted type and constraints are listed above and below.
actionenum | "edit"Required
Business action. Target fields and quantity requirements vary by action; see the request structure and example.
amountstringOptional
Credit or ledger amount, using the field’s decimal-string or integer type.
pattern: ^(0|[1-9]\d{0,11})(\.\d{1,6})?$
grantedstringOptional
The granted value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,11})(\.\d{1,6})?$
expiresAtdate-time | nullOptional
ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
nextResetAtdate-time | nullOptional
The nextResetAt value for this operation. Its accepted type and constraints are listed above and below.
expectedRevisionintegerOptional
The expectedRevision value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 9007199254740991
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"
balanceobjectRequired
The balance value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
sourceIduuidRequired
The sourceId value for this operation. Its accepted type and constraints are listed above and below.
availablestringRequired
The available value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
heldstringRequired
The held value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
spentstringRequired
The spent value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
adjustmentGrantIduuid | nullRequired
The adjustmentGrantId value for this operation. Its accepted type and constraints are listed above and below.
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.