Skip to content

Release capacity

End a capacity purchase. Hourly capacity ends immediately, with a one-hour minimum charge. Monthly capacity stays usable until the paid period ends. The first monthly purchase can end immediately with a refund within 48 hours, once per account. Remaining capacity must cover the pools' memory and keep stored data within 120% of its storage.

Parameters

#
capacitystringRequired
Capacity purchase ID from capacity view.
dry_runboolean
Preview the change without applying it.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The result or preview of buying or releasing capacity. A preview of the requested change.
Show 2 attributesHide attributes
alternative-1object
The result or preview of buying or releasing capacity.
Show 16 attributesHide attributes
charged_centsinteger
Charge now, or the previewed charge for a dry run, in cents. May be omitted.
checkout_urlstring
Page to pay for a first monthly purchase. May be omitted.
dry_runboolean
True for a preview; no purchase or release is made. May be omitted.
idstring
Capacity purchase ID. Absent when a dry run made no purchase. May be omitted.
invoice_urlstring
Invoice to pay when an additional purchase needs payment action. May be omitted.
kindstringAlways present
Hourly or monthly billing.
planintegerAlways present
Plan number being bought or released.
poolstring
Initial pool created for the account. May be omitted.
price_microsinteger
Purchase's price per hour or month, in millionths of a dollar. May be omitted.
refunded_centsinteger
Refund issued by this release, in cents. May be omitted.
releasedboolean
Whether the purchase has been released. May be omitted.
released_atstring (date-time)
Time this purchase was released. May be omitted.
releases_atstring (date-time)
When a scheduled monthly release takes effect. It can be canceled before that time. May be omitted.
stoppingstring[]
Pools that stop if their allocations still exceed capacity when the release takes effect. May be omitted.
unknownboolean
Whether the payment response was lost. Read capacity view before retrying. May be omitted.
wallet_microsinteger
Wallet balance after an hourly purchase, in millionths of a dollar. 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.