BRbrex-com
Budgets

Get Budget

Retrieves a Budget by ID

get/v2/budgets/{id}

Request

  • Base URL
    https://api.brex.com
  • Auth
    OAuth 2
    Authorization codehttps://accounts-api.brex.com/oauth2/default/v1/authorize
    Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
    Scopesbudgets.readonly, budgets
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Response

The Budget that was retrieved

budget_idstring required

Unique ID for the Budget.

account_idstring required

The Brex account this Budget belongs to.

namestring required

Name for the Budget.

descriptionstring nullable

Description of what the Budget is used for.

parent_budget_idstring nullable

ID of parent Budget.

owner_user_idsstring[] required

User IDs of the owners of the Budget.

period_recurrence_type'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' | 'ONE_TIME' required

Period type of the Budget e.g. MONTHLY.

start_datestring date nullable

The date when the Budget should start counting.

end_datestring date nullable

The date when the Budget should stop counting.

spend_budget_status'ACTIVE' | 'ARCHIVED' | 'DELETED' | 'EXPIRED' required

Status of the Budget e.g. ACTIVE.

limit_type'HARD' | 'SOFT' nullable

Whether the Budget amount blocks spend. HARD is rejected; use /v2/spend_limits for hard-auth limits.

Example response

{
  "amount": {
    "amount": 700,
    "currency": "USD"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.