Skip to content

organization_billing_budgets_get

Reads the monthly limit for extra charges of the organization that owns the product in product_id, this UTC month's counted extra charges, the 50/80/100% thresholds reached, and any open budget pause.

Tool

organization_billing_budgets_get

Reads the monthly limit for extra charges of the organization that owns the product in product_id, this UTC month's counted extra charges, the 50/80/100% thresholds reached, and any open budget pause.

Reads the monthly limit for extra charges of the organization that owns the product in product_id, this UTC month's counted extra charges, the 50/80/100% thresholds reached, and any open budget pause. To change the limit use organization_billing_budget_set; to remove it, organization_billing_budget_clear; to end a pause, organization_billing_budget_resume. Returns: { currency, budget: { amount_minor, action, updated_at } | null, month: { period, start, end }, counted_minor, lines: { resource, amount_minor }[], thresholds: { percent, reached_at }[], pause: { paused_at, period, amount_minor, counted_minor, resumable, blocked_by } | null, suspension, projection } suspension.reason "unusual_charges" means extra charges this month are unusually high: report it in those words, never as a limit and never with an amount; the remedy is organization_billing_budget_set or contacting support. Any other unknown reason is a billing restriction. Fails when: the caller does not own the organization.

Behavior

HTTP
GET /governance/api/v1/billing/budgets

Arguments

No arguments.

Try it

Reads the monthly limit for extra charges of the organization that owns the product in product_id, this UTC month's counted extra charges, the 50/80/100% thresholds reached, and any open budget pause.

When to use

Reads the monthly limit for extra charges of the organization that owns the product in product_id, this UTC month's counted extra charges, the 50/80/100% thresholds reached, and any open budget pause. To change the limit use organization_billing_budget_set; to remove it, organization_billing_budget_clear; to end a pause, organization_billing_budget_resume. Returns: { currency, budget: { amount_minor, action, updated_at } | null, month: { period, start, end }, counted_minor, lines: { resource, amount_minor }[], thresholds: { percent, reached_at }[], pause: { paused_at, period, amount_minor, counted_minor, resumable, blocked_by } | null, suspension, projection } suspension.reason "unusual_charges" means extra charges this month are unusually high: report it in those words, never as a limit and never with an amount; the remedy is organization_billing_budget_set or contacting support. Any other unknown reason is a billing restriction. Fails when: the caller does not own the organization.

Example

Ask your agent something like this:

Reads the monthly limit for extra charges of the organization that owns the product in product_id, this UTC month's counted extra charges, the 50/80/100% thresholds reached, and any open budget pause.

The agent will invoke organization_billing_budgets_get with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select