Accounts and money

Close an account

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

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/accounts/{accountId}/close
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

accountIdstring required

Hyperscale account ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

reasonstring required

Response

Success

tenantIdstring required

Organization tenant ID

accountIdstring required

Hyperscale account ID

productIdstring

Hyperscale product ID

updatedAtstring date-time required
reasonstring required
previousStatus'open' | 'frozen' required
status'closed' required

Changes

No recorded changes to this operation across all 1 revision of this API.