Create or archive a customer's usage entity, such as a workspace. The trusted backend supplies the customer; balance operations can reference the returned entity ID.
SDK 0.0.1Updated
Make the request
Create or archive a customer's usage entity, such as a workspace. The trusted backend supplies the customer; balance operations can reference the returned entity ID.
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
action"upsert" | "archive"Required
Business action. Target fields and quantity requirements vary by action; see the request structure and example.
externalIdstringOptional
The externalId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 128
namestringOptional
Display name of the customer or object; not an identity key.
minLength: 1 · maxLength: 80
entityIduuidOptional
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"
entityobjectRequired
The entity 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.
externalIdstringRequired
The externalId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 128
namestringRequired
Display name of the customer or object; not an identity key.
minLength: 1 · maxLength: 80
archivedbooleanRequired
The archived 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.