API Reference
  1. Reporting
  2. BudgetsAPI

Replaces a budget.

patch
https://api.cast.ai/reporting/v1beta/organizations//budgets/

Full replacement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Organization ID.

string
required

Budget ID.

Body Params

A single budget with its scope, window and notification configuration.

string
required

Human-readable budget name.

scope
object
required

Entity whose spend this budget tracks.

string
required

Budget cost, decimal encoded as string (e.g. "1234.56").

window
object
required

Measurement window over which spend is accumulated.

thresholds
array of objects

Alert thresholds. Each threshold fires an email to its own recipients when spend reaches its percent of budget_cost.
Omitted from List responses when include_thresholds is false.

thresholds
boolean
required

Whether the budget is evaluated. Paused budgets keep their configuration but do not fire.

Responses

Updated 1 hour ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 hour ago

Did this page help you?