billing.cost-report.preview

A month’s report as data, without sending it

GET /billing/api/cost-report/previewIAM billing:GetCostAndUsageRead

Request syntax

GET /billing/api/cost-report/preview

Query parameters

  • periodOptional

    string

    The billing month, YYYY-MM (default: last month)

    Constraints: /^\d{4}-(0[1-9]|1[0-2])$/

Response

200 with the report the mail would carry: kind (org), title, orgName, period, monthLabel, total (net of discounts and credits, before VAT), previousTotal, gross, discounts, credits, changePercent, groupLabel, services and resources [{ label, amount }], why (what moved the total), anomalies, movers { up, down }, waste (count, monthlySaving, the first 10 items), budgets [{ name, spend, amount, percent }] and explorerUrl. Amounts are EUR strings, 8 places (budgets: to the cent).

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:GetCostAndUsage 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 cost-report preview

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