Skip to content

Close an organization

Close an organization as its billing owner. Closure removes members, deletes Computers, pools and files, releases purchases and addresses, and refunds eligible unspent balance. Closure starts immediately if you are the only member. Otherwise, members get seven days' notice and you can cancel before closure starts.

Parameters

#
dry_runboolean
Preview the change without applying it.
cancelboolean
Cancel the scheduled closure and keep the organization.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The organization's closure state after scheduling, completing or canceling closure. A preview of the requested change.
Show 2 attributesHide attributes
alternative-1object
The organization's closure state after scheduling, completing or canceling closure.
Show 4 attributesHide attributes
closedboolean
Whether the organization closed immediately because no other members needed notice. May be omitted.
closes_atstring (date-time)
When scheduled closure takes effect. May be omitted.
namestringAlways present
Organization name.
unchangedboolean
True when cancellation found no scheduled closure to cancel. May be omitted.
alternative-2object
A preview of the requested change.
Show 3 attributesHide attributes
changesstring[]
Proposed effects and losses. May be omitted.
dry_runbooleanAlways present
True for a preview; no changes are made.
messagestringAlways present
What the request would do.

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.
  • Close: Close the organization. Optional: dry_run, organization.
  • Cancel: Cancel a scheduled organization closure. Required: cancel. Optional: organization.