Brex Budgets API

The Budgets API from Brex — 6 operation(s) for budgets.

OpenAPI Specification

brex-budgets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Brex Budget Programs Budgets API
  version: '1.0'
  description: Minimal OpenAPI 3.1 description of the Brex Budgets and Spend Limits API, derived from the public Brex developer documentation. Covers v1 and v2 budgets, spend limits, and budget programs resources.
  x-generated-from: https://developer.brex.com/openapi/budgets_api/
  x-generated-by: claude-crawl-2026-05-08
servers:
- url: https://platform.brexapis.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Budgets
paths:
  /v1/budgets:
    get:
      tags:
      - Budgets
      summary: List Spend Limits (v1)
      operationId: listV1Budgets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericListResponse'
    post:
      tags:
      - Budgets
      summary: Create a Spend Limit (v1)
      operationId: createV1Budget
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericObject'
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
  /v1/budgets/{id}:
    parameters:
    - $ref: '#/components/parameters/IdParam'
    get:
      tags:
      - Budgets
      summary: Retrieve a Spend Limit by ID (v1)
      operationId: getV1Budget
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
    put:
      tags:
      - Budgets
      summary: Update a Spend Limit (v1)
      operationId: updateV1Budget
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericObject'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
  /v1/budgets/{id}/archive:
    parameters:
    - $ref: '#/components/parameters/IdParam'
    post:
      tags:
      - Budgets
      summary: Archive a Spend Limit (v1)
      operationId: archiveV1Budget
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
  /v2/budgets:
    get:
      tags:
      - Budgets
      summary: List Budgets (v2)
      operationId: listV2Budgets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericListResponse'
    post:
      tags:
      - Budgets
      summary: Create a Budget (v2)
      operationId: createV2Budget
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericObject'
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
  /v2/budgets/{id}:
    parameters:
    - $ref: '#/components/parameters/IdParam'
    get:
      tags:
      - Budgets
      summary: Retrieve a Budget by ID (v2)
      operationId: getV2Budget
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
    put:
      tags:
      - Budgets
      summary: Update a Budget (v2)
      operationId: updateV2Budget
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericObject'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
  /v2/budgets/{id}/archive:
    parameters:
    - $ref: '#/components/parameters/IdParam'
    post:
      tags:
      - Budgets
      summary: Archive a Budget (v2)
      operationId: archiveV2Budget
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObject'
components:
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      schema:
        type: string
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
    GenericListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/GenericObject'
        next_cursor:
          type: string
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT