Parameters
#onboolean
Enable egress usage notices.
offboolean
Disable egress usage notices.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
The account's billing state, wallet and purchases.
Show 27 attributesHide attributes
auto_topup_centsinteger
Automatic top-up amount in cents. May be omitted.
auto_topup_monthly_limit_centsintegerAlways present
Monthly automatic top-up ceiling, in cents.
balance_microsintegerAlways present
Total remaining wallet credit, in millionths of a dollar.
can_managebooleanAlways present
Whether you can manage this account's billing.
cardobject
Saved payment card. May be omitted.
Show 4 attributesHide attributes
brandstring
Card brand reported by the payment provider. May be omitted.
exp_monthinteger
Expiration month, from 1 through 12. May be omitted.
exp_yearinteger
Four-digit expiration year. May be omitted.
last4stringAlways present
Last four digits of the card number.
card_formboolean
Whether the card setup form is available. May be omitted.
card_savedbooleanAlways present
Whether a payment card is saved.
contactsstring[]
Additional recipients of billing email. May be omitted.
egressobject
This month's outbound traffic usage, charges and cap. May be omitted.
Show 12 attributesHide attributes
allowance_bytesintegerAlways present
Internet egress included for the month, in bytes.
capstringAlways present
Egress cap setting:
default, amount or off.cap_microsinteger
Monthly cap in millionths of a dollar. Absent when the cap is off. May be omitted.
charged_microsintegerAlways present
Egress charged so far this month, in millionths of a dollar.
chargingbooleanAlways present
Whether egress overage is currently billed.
monthstring (date-time)Always present
Month being measured.
not_charged_bytesinteger
Overage bytes not charged while the wallet was past its grace period. May be omitted.
over_bytesintegerAlways present
Usage above the included allowance, in bytes.
projected_bytesintegerAlways present
Estimated monthly egress based on use so far, in bytes.
slowedbooleanAlways present
Whether the account's internet egress is currently slowed because of its egress cap, its spending cap or its wallet state.
used_bytesintegerAlways present
Internet egress used this month, in bytes.
would_charge_microsinteger
What overage would cost if charging were enabled, in millionths of a dollar. May be omitted.
entriesobject[] | nullAlways present
Recent wallet ledger entries.
Show 1 attributeHide attributes
itemsobject
One wallet ledger entry.
Show 4 attributesHide attributes
amount_microsintegerAlways present
Signed change in wallet balance, in millionths of a dollar.
atstring (date-time)Always present
When the entry was recorded.
kindstringAlways present
Reason for the credit or debit.
poolstring
Pool associated with the entry, when present. May be omitted.
heldboolean
Whether billing has placed the account on hold. May be omitted.
lasts_hoursnumber
Estimated wallet lifetime in hours at current spending. May be omitted.
next_renewalstring (date-time)
When the next monthly renewal is due. May be omitted.
noticesstring[] | nullAlways present
Billing issues or changes needing attention.
paid_microsintegerAlways present
Remaining purchased wallet credit, in millionths of a dollar.
pay_bystring
Account's payment method. May be omitted.
payments_offboolean
Whether payments are disabled. May be omitted.
per_hour_microsintegerAlways present
Hourly wallet spending, in millionths of a dollar.
promo_expiringobject[]
Promotional credits expiring soon. May be omitted.
Show 1 attributeHide attributes
itemsobject
A wallet credit grant.
Show 8 attributesHide attributes
amount_microsintegerAlways present
Original credit amount in millionths of a dollar.
created_atstring (date-time)Always present
When the credit was granted.
expires_atstring (date-time)
When unused credit expires, if an expiry is set. May be omitted.
idstringAlways present
Credit grant's ID.
refundablebooleanAlways present
Whether this credit is eligible for a refund.
remaining_microsintegerAlways present
Credit still available, in millionths of a dollar.
scopestring[]
Spending categories this credit can pay for. May be omitted.
sourcestringAlways present
Origin of this credit.
promo_microsintegerAlways present
Remaining promotional wallet credit, in millionths of a dollar.
purchasesobject[] | nullAlways present
Purchases being billed and any scheduled changes.
Show 1 attributeHide attributes
itemsobject
A billed capacity purchase and its pending changes.
Show 11 attributesHide attributes
amount_microsintegerAlways present
Price per billing period, in millionths of a dollar.
changestring
Scheduled change to this purchase. May be omitted.
change_atstring (date-time)
When the scheduled change takes effect. May be omitted.
change_planinteger
Plan selected by a scheduled resize. May be omitted.
idstringAlways present
Capacity purchase ID.
modelstringAlways present
Billing model.
pendingboolean
Whether the first payment is pending. May be omitted.
planintegerAlways present
Purchased plan number.
poolsstring[] | nullAlways present
Pools that can use capacity from this purchase.
regionstring
Purchase's region. May be omitted.
switch_saves_microsinteger
Estimated monthly savings from switching to monthly billing, in millionths of a dollar. May be omitted.
renewal_microsintegerAlways present
Account's monthly renewal total, in millionths of a dollar.
spend_alert_microsinteger | nullAlways present
Monthly spending alert threshold in millionths of a dollar; null disables alerts.
spending_cap_microsinteger | nullAlways present
Monthly spending cap in millionths of a dollar, past which nothing is charged; null for none.
subscription_statusstring
Payment provider's current subscription state. May be omitted.
time_zonestringAlways present
Account's time zone for billing communications.
usage_emailsbooleanAlways present
Whether monthly usage emails are enabled.
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.
- On: Enable egress usage notices. Required:
on. Optional:organization. - Off: Disable egress usage notices. Required:
off. Optional:organization.