Hyperscale docs Sign in Start building

Close an account

account.close

Moves an open or frozen account to closed status only after the ledger reports zero posted balance and no pending debit or credit holds. Closing over a system-plane freeze is refused the same way tenant unfreeze is.

POST /v1/accounts/{accountId}/close

Scopes: account:write

Input

FieldTypeDescription
accountId requiredstringHyperscale account ID
reason requiredstring
idempotencyKey requiredstringNew per change; reuse only to retry it.
confirmation requiredaccount_close | account.closeThis tool's name, once the founder agrees.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/accounts/{accountId}/close' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "reason": "<string>",
  "idempotencyKey": "<string>",
  "confirmation": "<account_close | account.close>"
}'

All operations