Skip to content

Delete your account

Delete your account and leave your organizations. The first call requests an email verification code. Give the code to confirm deletion, then read the returned operation to follow it. Your Computers in organizations with other members transfer to the selected member or organization. Your payment methods stop paying for organizations where you are billing owner, and another member is offered billing ownership. Organizations with no remaining members close and their resources are deleted.

Parameters

#
transfer_computers_toobject
Show 1 attributeHide attributes
userstringRequired
Email address or user ID of the member to receive your Computers. Ownership goes to the organization by default.
codestring
Verification code sent to your sign-in email address. Treated as a secret and never included in errors.

Returns

#
dataobjectAlways present
A deletion preview and confirmation deadline, or an accepted deletion operation group.
Show 2 attributesHide attributes
alternative-1object
The effects of deleting your account and the confirmation required to proceed.
Show 8 attributesHide attributes
addressesstring[] | nullAlways present
Your personal static addresses to be released.
balance_microsintegerAlways present
Wallet balance forfeited without refund, in millionths of a US dollar.
capacitystring[] | nullAlways present
Your personal capacity purchases to be released.
code_expires_atstring (date-time)Always present
When the confirmation code expires.
code_sent_tostringAlways present
Email address receiving the deletion confirmation code.
computersstring[] | nullAlways present
Your personal Computers to be deleted.
organizationsobject[] | nullAlways present
Organizations you leave or close, and who receives your Computers there.
Show 1 attributeHide attributes
itemsobject
How deleting your account affects one organization.
Show 8 attributesHide attributes
addressesstring[]
Static addresses released when the organization closes. May be omitted.
billing_ownerbooleanAlways present
Whether you are this organization's billing owner.
closesbooleanAlways present
Whether the organization closes because you are its last member.
computersstring[] | nullAlways present
Computers you own in this organization.
computers_tostringAlways present
Who receives those Computers. Empty when the organization closes and they are deleted.
idstringAlways present
Organization ID.
namestringAlways present
Organization name.
poolsstring[]
Pools removed when the organization closes. May be omitted.
poolsstring[] | nullAlways present
Your personal pools to be deleted.
alternative-2object
The current state of a grouped change.
Show 1 attributeHide attributes
operationobjectAlways present
Group and the operations or steps that determine its outcome.
Show 10 attributesHide attributes
completed_atstring (date-time)
When the group finished. Absent while unfinished. May be omitted.
created_atstring (date-time)Always present
When the grouped change was accepted.
idstringAlways present
Group ID for operation view.
kindstringAlways present
Grouped change.
messagestring
An explanation of the group's progress or failure. May be omitted.
operationsobject[] | nullAlways present
Member Computer operations.
Show 1 attributeHide attributes
itemsobject
An accepted change to one Computer. Work continues after the request disconnects.
Show 9 attributesHide attributes
bystring
Requester's email address, or user ID if no email is recorded. Omitted for your own requests. May be omitted.
completed_atstring (date-time)
When the operation reached its final state. Absent while unfinished. May be omitted.
computer_idstringAlways present
Computer's stable ID.
created_atstring (date-time)
When Heaven accepted the change. May be omitted.
error_codestring
Recorded failure code. May be omitted.
idstringAlways present
Operation ID for operation view.
kindstringAlways present
Change being tracked.
messagestring
An explanation of the recorded failure and any next action. May be omitted.
statestringAlways present
accepted means saved and unfinished. complete means the change finished. failed means it could not finish. superseded means a newer change replaced it before completion. Values: "accepted", "complete", "failed", "superseded".
pool_idstring
Pool this change concerns. May be omitted.
statestringAlways present
accepted while work remains, complete when all work succeeds, or failed when a step fails or a member operation fails or is superseded. Values: "accepted", "complete", "failed", "superseded".
stepsobject[]
Other steps, in execution order. May be omitted.
Show 1 attributeHide attributes
itemsobject
A step in a grouped change outside its Computer operations.
Show 5 attributesHide attributes
kindstringAlways present
Action taken by this step.
messagestring
Progress or failure details for this step. May be omitted.
pool_idstring
Affected pool's ID. May be omitted.
statestringAlways present
Step's recorded progress or outcome.
subjectstring
Affected object, such as an organization being left. May be omitted.
subjectstring
Other object the change concerns, such as a pool snapshot's name. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.
  • Send the code: Email a verification code and preview account deletion. Optional: transfer_computers_to.
  • Delete: Confirm account deletion with the emailed verification code. Required: code. Optional: transfer_computers_to.