billing.budgets.status

List budgets with current spend, scope size and fired alerts

GET /billing/api/budgets/statusIAM billing:GetBudgetsRead

Reports whether a budget’s scope currently selects no billable resource — a budget guarding an empty set looks identical to one that is guarding something.

Request syntax

GET /billing/api/budgets/status

Response

200 with one entry per budget: { budget (as `list` shows it), evaluation, alerts }. evaluation: name, amountCents, period, window { key, label, start, end }, scope, scopeDescription, projectName, scopeValid, scopeError, matchesEverything, matchedResources, billableResources, byType, services, spendCents, unattributableCents, percentUsed, thresholds, crossed, forecastCents, forecastPercent, forecastThresholds, forecastCrossed. alerts: the ones fired this period (thresholdPercent, kind actual or forecast, spendCents, …).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow billing:GetBudgets on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud billing budgets status

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_billing_budgets_status.