The budgets API lets you manage your Brex Budgets and Spend Limits.
Budgets API (1.0)
Download OpenAPI description
Overview
Languages
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(Required scopes:
budgets.readonly
budgets
)- Productionhttps://api.brex.com/v1/budget_programs
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/v1/budget_programs
- curl
- JavaScript
- Node.js
- Python
- Ruby
- Java
curl -i -X GET \
https://api.brex.com/v1/budget_programs \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'A page with a list of Budget Programs
Description of what the Spend Limit is used for.
User IDs of the owners of the Spend Limit.
Period type of the Spend Limit e.g. MONTHLY.
Enum"WEEKLY""MONTHLY""QUARTERLY""YEARLY""ONE_TIME"
The UTC date when the Spend Limit should start counting.
The UTC date when the Spend Limit should stop counting.
Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Whether the Spend Limit's limit blocks spend.
Enum"HARD""SOFT"
Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit.
Enum"BUDGET_PROVISIONED_CARDS_ONLY""NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
IDs for existing Spend Limits associated with this Budget Program.
A filter used to determine if a user adheres to a Budget Program.
Enum"BUDGET_PROGRAM_STATUS_ACTIVE""BUDGET_PROGRAM_STATUS_INACTIVE""BUDGET_PROGRAM_STATUS_DELETED"
Response
application/json
{ "next_cursor": "string", "items": [ { … } ] }
- Productionhttps://api.brex.com/v1/budget_programs/{id}
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/v1/budget_programs/{id}
- curl
- JavaScript
- Node.js
- Python
- Ruby
- Java
curl -i -X GET \
'https://api.brex.com/v1/budget_programs/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The Budget Program that was retrieved
User IDs of the owners of the Spend Limit.
Period type of the Spend Limit e.g. MONTHLY.
Enum"WEEKLY""MONTHLY""QUARTERLY""YEARLY""ONE_TIME"
The UTC date when the Spend Limit should start counting.
The UTC date when the Spend Limit should stop counting.
Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Whether the Spend Limit's limit blocks spend.
Enum"HARD""SOFT"
Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit.
Enum"BUDGET_PROVISIONED_CARDS_ONLY""NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
IDs for existing Spend Limits associated with this Budget Program.
Enum"BUDGET_PROGRAM_STATUS_ACTIVE""BUDGET_PROGRAM_STATUS_INACTIVE""BUDGET_PROGRAM_STATUS_DELETED"
Response
application/json
{ "id": "string", "name": "string", "description": "string", "budget_blueprints": [ { … } ], "existing_budget_ids": [ "string" ], "employee_filter": { "employment_status": "EMPLOYMENT_STATUS_ACTIVE", "employment_type": "EMPLOYMENT_TYPE_FULL_TIME" }, "budget_program_status": "BUDGET_PROGRAM_STATUS_ACTIVE", "creator_user_id": "string", "created_at": "2019-08-24", "updated_at": "2019-08-24" }