Budget Programs

Get Budget Program

Retrieves a Budget Program by ID

get/v1/budget_programs/{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
https://skmtc.dev/brex-com/apis/budgets-api/docs/v1/budget_programs/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

The Budget Program that was retrieved

idstring required

namestring required

descriptionstring nullable

existing_budget_idsstring[] nullable

IDs for existing Spend Limits associated with this Budget Program.

budget_program_status'BUDGET_PROGRAM_STATUS_ACTIVE' | 'BUDGET_PROGRAM_STATUS_INACTIVE' | 'BUDGET_PROGRAM_STATUS_DELETED' required

creator_user_idstring nullable

created_atstring date required

updated_atstring date required

{
  "budget_blueprints": [
    {
      "limit": {
        "amount": 700,
        "currency": "USD"
      }
    }
  ]
}

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