Parameters
#organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
Recorded and estimated costs for a calendar month. Monetary amounts are millionths of a US dollar.
Show 9 attributesHide attributes
by_end_microsintegerAlways present
Estimated total cost by the month's end.
daysobject[] | nullAlways present
Daily costs, including estimates for time still to come.
Show 1 attributeHide attributes
itemsobject
A day's costs, in millionths of a US dollar.
Show 7 attributesHide attributes
datestringAlways present
UTC calendar date.
egress_microsintegerAlways present
Cost of internet egress overage.
estimatedbooleanAlways present
Whether this day includes an estimate.
estimated_microsintegerAlways present
Portion of the total estimated for time still to come.
poolsobject[] | nullAlways present
Each pool's cost for the day.
Show 1 attributeHide attributes
itemsobject
A pool's cost for one day.
Show 2 attributesHide attributes
microsintegerAlways present
Pool's cost in millionths of a dollar.
pool_idstringAlways present
Pool ID.
total_microsintegerAlways present
Day's total, including any estimated portion.
unused_microsintegerAlways present
Cost of purchased capacity not allocated to pools.
fromstring (date-time)Always present
Start of that month in UTC.
linesobject[] | nullAlways present
Costs by pool, unused capacity and egress.
Show 1 attributeHide attributes
itemsobject
Monthly costs for a pool, unused capacity or egress. Monetary amounts are millionths of a US dollar.
Show 12 attributesHide attributes
billedstringAlways present
Payment source: monthly, hourly, both, provided capacity or wallet. Empty when nothing is held.
by_end_microsintegerAlways present
Estimated total by month's end.
deletedboolean
True for a pool deleted during this month. May be omitted.
hourly_microsintegerAlways present
Current cost per hour attributed to this line.
kindstringAlways present
pool, unused or egress, identifying what this line measures.memory_bytesinteger
Unused purchased RAM in bytes, for unused-capacity lines. May be omitted.
monthly_microsintegerAlways present
Current monthly capacity cost attributed to this line.
paid_atstring (date-time)
When the current monthly period was paid. May be omitted.
poolstring
Pool name. May be omitted.
pool_idstring
Pool's ID for a pool line. May be omitted.
so_far_microsintegerAlways present
Cost recorded so far this month.
vcpusinteger
Unused purchased vCPUs, for unused-capacity lines. May be omitted.
monthstringAlways present
Selected calendar month.
nowstring (date-time)Always present
When these costs were read.
so_far_microsintegerAlways present
Recorded cost so far in the month.
spend_alert_microsinteger | nullAlways present
Monthly alert threshold, or null without an alert.
tostring (date-time)Always present
Start of the following month in UTC.
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. |
| 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
#- API key permission:
billing cost.