Skip to content

Set the spend alert

Set or remove a monthly spending alert for the billing owner, admins and billing contacts. Heaven checks spending against 75% and 100% of the threshold and emails the highest newly reached level.

Parameters

#
amountstring
Monthly spending threshold in dollars, at least $1.
offboolean
Turn off the monthly spending alert.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The account's monthly spending alert setting.
Show 2 attributesHide attributes
spend_alert_microsinteger | nullAlways present
Alert threshold in millionths of a dollar, or null when disabled.
updatedbooleanAlways present
Whether the setting was saved.

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.
payment_required402Payment or credit is required.
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

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.
  • Set: Send email when monthly costs reach 75% and 100% of the chosen amount. Required: amount. Optional: organization.
  • Off: Disable spending alert emails. Required: off. Optional: organization.