# Budgets API


The budgets API lets you manage your Brex Budgets and Spend Limits.


Version: 1.0

## Servers

Production
```
https://api.brex.com
```

Staging (Note: This is not a sandbox. It will not work with customer tokens.)
```
https://api-staging.brex.com
```

## Security

### OAuth2

OAuth2 security scheme

Type: oauth2

## Download OpenAPI description

[Budgets API](https://developer.brex.com/_bundle/openapi/budgets_api.yaml)

## Spend Limits (v1)

Endpoints for Spend Limits data. Please note that /v1/budgets targets spend limits, and will soon be deprecated in favor of /v2/spend_limits.

### List Spend Limits

 - [GET /v1/budgets](https://developer.brex.com/openapi/budgets_api/spend-limits-(v1)/listbudgets.md): Lists Spend Limits belonging to this account

### Create Spend Limit

 - [POST /v1/budgets](https://developer.brex.com/openapi/budgets_api/spend-limits-(v1)/createbudget.md): Creates a Spend Limit

### Get Spend Limit

 - [GET /v1/budgets/{id}](https://developer.brex.com/openapi/budgets_api/spend-limits-(v1)/getbudgetbyid.md): Retrieves a Spend Limit by ID

### Update Spend Limit

 - [PUT /v1/budgets/{id}](https://developer.brex.com/openapi/budgets_api/spend-limits-(v1)/updatebudget.md): Updates a Spend Limit

### Archive a Spend Limit

 - [POST /v1/budgets/{id}/archive](https://developer.brex.com/openapi/budgets_api/spend-limits-(v1)/archivebudget.md): Archives a Spend Limit, making it unusable for future expenses and removing it from the UI

## Budget Programs

Endpoints for Budget Programs data.

### List Budget Programs

 - [GET /v1/budget_programs](https://developer.brex.com/openapi/budgets_api/budget-programs/listbudgetprograms.md): Lists Budget Programs belonging to this account

### Get Budget Program

 - [GET /v1/budget_programs/{id}](https://developer.brex.com/openapi/budgets_api/budget-programs/getbudgetprogrambyid.md): Retrieves a Budget Program by ID

## Budgets

Endpoints for Budgets data.

### List Budgets

 - [GET /v2/budgets](https://developer.brex.com/openapi/budgets_api/budgets/listspendbudgets.md): Retrieves a list of Budgets

### Create Budget

 - [POST /v2/budgets](https://developer.brex.com/openapi/budgets_api/budgets/createspendbudget.md): Creates a Budget

### Get Budget

 - [GET /v2/budgets/{id}](https://developer.brex.com/openapi/budgets_api/budgets/getspendbudgetbyid.md): Retrieves a Budget by ID

### Update Budget

 - [PUT /v2/budgets/{id}](https://developer.brex.com/openapi/budgets_api/budgets/updatespendbudget.md): Updates a Budget

### Archive a Budget

 - [POST /v2/budgets/{id}/archive](https://developer.brex.com/openapi/budgets_api/budgets/archivespendbudget.md): Archives a Budget, making any Spend Limits beneath it unusable for future expenses and removing it from the UI

## Spend Limits (v2)

Endpoints for spend limits data.

### List Spend Limits

 - [GET /v2/spend_limits](https://developer.brex.com/openapi/budgets_api/spend-limits-(v2)/listspendlimits.md): Retrieves a list of Spend Limits

### Create Spend Limit

 - [POST /v2/spend_limits](https://developer.brex.com/openapi/budgets_api/spend-limits-(v2)/createspendlimit.md): Creates a Spend Limit

### Get Spend Limit

 - [GET /v2/spend_limits/{id}](https://developer.brex.com/openapi/budgets_api/spend-limits-(v2)/getspendlimitbyid.md): Retrieves a Spend Limit by ID

### Update Spend Limit

 - [PUT /v2/spend_limits/{id}](https://developer.brex.com/openapi/budgets_api/spend-limits-(v2)/updatespendlimit.md): Updates a Spend Limit

### Archive a Spend Limit

 - [POST /v2/spend_limits/{id}/archive](https://developer.brex.com/openapi/budgets_api/spend-limits-(v2)/archivespendlimit.md): Archives a Spend Limit, making it unusable for future expenses and removing it from the UI