API Reference

Create Budget

post
https://api.umbrellacost.io/api/v2/budgets

The call is used to create budgets and budget alerts

Body Params
string
required

The name in the Umbrella Cost UI

string
required

Valid values: “amortized”,”net_amortized”,”unblended”

string
required

Valid values: “recurring”, “expiring”

string
required

Valid values: “fixed”,”planned”

integer
required

The total budget

budgetAmounts
array of strings
required

An array of amount and month pairs. Example: {"amount": 1234 ,"date": "2024-2"},{"amount": 5000 ,"date": "2024-3"}

budgetAmounts*
string
required

Valid Values: "true", "false"

string

Do not use this parameter

integer
required

Valid values: 0-"Monthly", 1-"Quarterly", 2-"Yearly"

date-time
required

Example: “2024-02-11T09:25:29.800Z”

date-time
required

Example: "2025-02-11T09:25:29.809Z"

string

object of filter keys - Example: {"region": ["af-south-1"]}

string

object of filter keys - Example: {"chargetype": ["Tax"]}

budgetAlerts
array of strings

An array of alerts defined over the budget

budgetAlerts
whenToAlert
array of strings
required

Valid values: “forecasted", ”actualUsage” of both

whenToAlert*
alertGranularity
array of strings
required

Valid values: ”monthly”, “daily”, “total” or combinations of them

alertGranularity*
string
required

Budget percent utilization thereshold

string
required

valid email addresses, separated by commas

Headers
string
required
string
required
Response
200

Updated 5 months ago

Language
LoadingLoading…

Updated 5 months ago