---
title: "Create Budget"
method: POST
path: "/api/v2/budgets"
tags: ["Budgets"]
---

# Create Budget

`POST /api/v2/budgets`

## Request

- Base URL: `https://api.umbrellacost.io`
- URL: `https://api.umbrellacost.io/api/v2/budgets`
- Auth: none declared. Required headers: `Authorization`, `apikey`

The call is used to create budgets

## Headers

- `Authorization` string, required
- `apikey` string, required

## Request body

- object
  - `budgetName` string, required: The name in the Umbrella Cost UI
  - `costType` string, required: Valid values: “amortized”,”net_amortized”,”unblended”
  - `budgetType` string, required: Valid values: “recurring”, “expiring”
  - `budgetAmountType` string, required: Valid values: “fixed”,”planned”
  - `budgetAmount` integer, required: The total budget
  - `budgetAmounts` string[], required: An array of amount and month pairs. Example: {"amount": 1234 ,"date": "2024-2"},{"amount": 5000 ,"date": "2024-3"}
  - `isFlexible` string, required: Valid Values: "true", "false"
  - `isRelativeAlerts` string: Do not use this parameter
  - `period` integer, required: Valid values: 0-"Monthly", 1-"Quarterly", 2-"Yearly"
  - `startDate` string, date-time, required: Example: “2024-02-11T09:25:29.800Z”
  - `endDate` string, date-time, required: Example: "2025-02-11T09:25:29.809Z"
  - `includeFilters` string: object of filter keys - Example: {"region": ["af-south-1"]}
  - `excludeFilters` string: object of filter keys - Example: {"chargetype": ["Tax"]}
  - `budgetAlerts` string[]: An array of alerts defined over the budget
  - `whenToAlert` string[], required: Valid values: “forecasted", ”actualUsage” of both
  - `alertGranularity` string[], required: Valid values: ”monthly”, “daily”, “total” or combinations of them
  - `alertPercent	` string, required: Budget percent utilization thereshold
  - `alertEmail` string, required: valid email addresses, separated by commas

## Response `200`

---

[API](https://skmtc.dev/umbrellacost/apis/advanced-services.md) - [All operations](https://skmtc.dev/umbrellacost/apis/advanced-services/llms.txt) - [OpenAPI document](https://skmtc.dev/umbrellacost/apis/advanced-services/revisions/fde38bef0656?raw)
