Skip to content

List plans

List capacity plans and their prices, sizes, billing options and availability for your account.

Returns

#
dataobjectAlways present
Plans and prices offered to this account.
Show 2 attributesHide attributes
egress_micros_per_gbintegerAlways present
Internet egress overage price per decimal gigabyte, in millionths of a dollar.
plansobject[] | nullAlways present
Available plan definitions, including approval and current capacity availability.
Show 1 attributeHide attributes
itemsobject
A plan's capacity, prices and availability. Prices are millionths of a US dollar.
Show 13 attributesHide attributes
approvalboolean
Whether buying this plan requires approval. May be omitted.
approvedboolean
Whether this account has that approval. May be omitted.
egress_bytesintegerAlways present
Monthly internet egress added to the account's allowance, in bytes.
hourly_microsintegerAlways present
Hourly price for this account.
hourly_passes_monthly_hoursintegerAlways present
Hours held in a month beyond which hourly billing costs more than monthly.
memory_bytesintegerAlways present
Plan's RAM allocation, in bytes.
monthly_microsintegerAlways present
Monthly price for this account.
no_roomboolean
Whether all placements lack room for a new purchase. An existing purchase may still have room to grow. May be omitted.
planintegerAlways present
Plan number accepted by purchase commands.
public_portsintegerAlways present
Public port allowance for an account holding only this plan in a placement.
storage_bytesintegerAlways present
Plan's included storage, in bytes.
unitsintegerAlways present
Number of capacity units in this plan.
vcpusintegerAlways present
Plan's vCPU allocation.

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.
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

#
  • API key permission: plan view.