Parameters
#planstring
The plan number to purchase, from
plan view.monthlyboolean
Pay through the account's monthly subscription (default).
hourlyboolean
Pay from your wallet by the minute, with a minimum charge of one hour.
monthsstring
Length of the prepaid monthly term, in months. Choose 1 (default) or 12. See
plan view for the discount.offerstring
Offer code for this purchase.
dry_runboolean
Preview the change without applying it.
serverstring
Server identifier from
capacity view. Defaults to the server with the most room.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.
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.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- CLI:
heaven loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). - A key limited to a command list cannot run this command.
- For retries, reuse the original
Idempotency-Keyand inputs.