Skip to content

Read an organization's usage

Read an organization's pool usage and capacity charges for the month so far, starting at midnight UTC on the first. Requires billing owner or organization admin access.

Parameters

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

Returns

#
dataobjectAlways present
The organization's spending, pool activity and measured use over the selected month.
Show 7 attributesHide attributes
balance_microsintegerAlways present
Current wallet balance in millionths of a dollar.
capacityobject[] | nullAlways present
Capacity purchases and their costs.
Show 1 attributeHide attributes
itemsobject
One capacity purchase's cost in the reporting period.
Show 7 attributesHide attributes
charged_microsintegerAlways present
Amount charged to the wallet in this period, in millionths of a dollar.
idstringAlways present
Purchase ID.
kindstringAlways present
Cost category or billing model.
monthly_microsinteger
Purchase's current monthly price, in millionths of a dollar. May be omitted.
planinteger
Plan number, where applicable. May be omitted.
regionstring
Purchase's region. May be omitted.
releasedboolean
Whether this purchase was released. May be omitted.
charged_microsintegerAlways present
Wallet charges in the reporting period, in millionths of a dollar.
fromstring (date-time)Always present
Start of the reporting period.
history_unavailableboolean
Whether usage history could not be read. May be omitted.
poolsobject[] | nullAlways present
Activity and measured usage for each pool.
Show 1 attributeHide attributes
itemsobject
A pool's activity and use in the reporting period. Null measurements are unknown.
Show 10 attributesHide attributes
cpu_vcpus_avgnumber | nullAlways present
Average measured vCPUs in use.
hoursmap<string, number> | nullAlways present
Hours recorded in each power state.
idstringAlways present
Pool ID.
lifecyclestringAlways present
Pool's lifecycle state.
net_rx_bytesinteger | nullAlways present
Measured bytes received.
net_tx_bytesinteger | nullAlways present
Measured bytes sent.
poolstringAlways present
Pool name.
powerstringAlways present
Pool's power setting.
providedboolean
Whether Heaven provides the capacity without charging the organization. May be omitted.
storagestring
Current files and snapshots against included storage, as readable text. May be omitted.
tostring (date-time)Always present
End of the reporting period.

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: organization usage.