Skip to content

Read your capacity

List your organization's capacity purchases and the capacity still available for pools on each server. Use purchase IDs here to resize, switch or release capacity.

Parameters

#
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The account's capacity purchases and pool allocations.
Show 4 attributesHide attributes
had_computerbooleanAlways present
Whether this account has ever created a Computer, including a deleted one.
purchasesobject[] | nullAlways present
Purchases held by the account, including payment-pending or lapsed purchases.
Show 1 attributeHide attributes
itemsobject
A capacity purchase and its payment status.
Show 15 attributesHide attributes
checkout_urlstring
Payment page for a pending purchase. May be omitted.
created_atstring (date-time)Always present
When the purchase was created.
idstringAlways present
Purchase ID used for changes or release.
kindstringAlways present
Billing model.
memory_bytesintegerAlways present
RAM included by this purchase, in bytes.
next_termsobject
Scheduled replacement terms. May be omitted.
Show 8 attributesHide attributes
amount_microsintegerAlways present
Price per billing period before discounts or a trial, in millionths of the currency.
currencystringAlways present
Currency of the price.
egress_gbintegerAlways present
Included monthly internet egress in decimal gigabytes.
modelstringAlways present
Hourly or monthly billing. Values: "hourly", "monthly".
planintegerAlways present
Plan number.
rate_cardobjectAlways present
Rates for usage beyond included allowances.
Show 2 attributesHide attributes
egress_micros_per_gbintegerAlways present
Internet egress overage price per decimal gigabyte, in millionths of a dollar.
hourly_minimum_minutesintegerAlways present
Minimum billed duration of an hourly purchase, in minutes.
storage_gbintegerAlways present
Included storage in decimal gigabytes.
unitsintegerAlways present
Number of capacity units purchased.
next_terms_atstring (date-time)
When replacement terms take effect. Monthly changes apply at renewal. May be omitted.
pays_microsinteger
Current price per hour or month according to kind, in millionths of a dollar. May be omitted.
planintegerAlways present
Purchased plan number.
poolsstring[] | nullAlways present
Pools that use capacity in this purchase's placement.
regionstring
Purchase's region. May be omitted.
statestringAlways present
active capacity is available. pending awaits its first monthly payment. out_of_funds, capped (stopped at the spending cap) and unpaid purchases have lapsed and contribute no capacity.
storage_bytesintegerAlways present
Storage included by this purchase, in bytes.
termsobject
Price and allowances agreed to for this purchase. May be omitted.
Show 8 attributesHide attributes
amount_microsintegerAlways present
Price per billing period before discounts or a trial, in millionths of the currency.
currencystringAlways present
Currency of the price.
egress_gbintegerAlways present
Included monthly internet egress in decimal gigabytes.
modelstringAlways present
Hourly or monthly billing. Values: "hourly", "monthly".
planintegerAlways present
Plan number.
rate_cardobjectAlways present
Rates for usage beyond included allowances.
Show 2 attributesHide attributes
egress_micros_per_gbintegerAlways present
Internet egress overage price per decimal gigabyte, in millionths of a dollar.
hourly_minimum_minutesintegerAlways present
Minimum billed duration of an hourly purchase, in minutes.
storage_gbintegerAlways present
Included storage in decimal gigabytes.
unitsintegerAlways present
Number of capacity units purchased.
vcpusintegerAlways present
vCPUs included by this purchase.
serversobject[] | nullAlways present
Capacity totals grouped by where the account's pools can use them.
Show 1 attributeHide attributes
itemsobject
Purchased and allocated capacity for pools in one placement.
Show 8 attributesHide attributes
memory_allocated_bytesintegerAlways present
Purchased RAM allocated to pools here, in bytes.
memory_bought_bytesintegerAlways present
RAM purchased here, in bytes.
poolsstring[] | nullAlways present
Pools using this placement's capacity.
regionstring
Region containing these pools. May be omitted.
storage_allocated_bytesintegerAlways present
Purchased storage allocated to pools here, in bytes.
storage_bought_bytesintegerAlways present
Storage purchased here, in bytes.
vcpus_allocatedintegerAlways present
Purchased vCPUs allocated to pools here.
vcpus_boughtintegerAlways present
vCPUs purchased here.
storageobject[] | nullAlways present
Storage included and used in each placement group.
Show 1 attributeHide attributes
itemsobject
The account's storage in one placement, including stopped pools.
Show 3 attributesHide attributes
included_bytesintegerAlways present
Storage included by the account's purchases here, in bytes.
regionstring
Region of this storage. May be omitted.
used_bytesintegerAlways present
Files and snapshots stored here as last measured, in bytes.

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: capacity view.