Brex: Get Budget
Brex budgets.budgetsGetSpendBudgetById: arguments, response, policy and SDK examples.
← Budgets operations · Get started
Operation brex.budgets_getspendbudgetbyid
Provider route: GET /v2/budgets/{id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["budgets"]["budgetsGetSpendBudgetById"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.budgets.budgetsGetSpendBudgetById(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_brex import BrexIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.budgets.budgets_get_spend_budget_by_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Budget — response body |
Referenced models: Get Budget — response body
Schemas
Section titled “Schemas”Get Budget — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Required within parent | The Brex account this Budget belongs to. |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
amount (anyOf 2) | null | Alternative | |
budget_id | string | Required within parent | Unique ID for the Budget. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of what the Budget is used for. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The date when the Budget should stop counting. Format: date |
end_date (anyOf 2) | null | Alternative | |
limit_type | JSON | Optional | |
limit_type (anyOf 1) | JSON | Alternative | |
limit_type (anyOf 1) (allOf 1) | string | All variants apply | Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. Known values: HARD, SOFT |
limit_type (anyOf 1) (allOf 2) | JSON | All variants apply | Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. |
limit_type (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name for the Budget. |
owner_user_ids | array | Required within parent | User IDs of the owners of the Budget. |
owner_user_ids[] | string | Each item | |
parent_budget_id | JSON | Optional | |
parent_budget_id (anyOf 1) | string | Alternative | ID of parent Budget. |
parent_budget_id (anyOf 2) | null | Alternative | |
period_recurrence_type | JSON | Required within parent | |
period_recurrence_type (allOf 1) | string | All variants apply | Period type of the Budget e.g. MONTHLY. Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
period_recurrence_type (allOf 2) | JSON | All variants apply | Period type of the Budget e.g. MONTHLY. |
spend_budget_status | JSON | Required within parent | |
spend_budget_status (allOf 1) | string | All variants apply | Status of the Budget e.g. ACTIVE. Known values: ACTIVE, ARCHIVED, DELETED, EXPIRED |
spend_budget_status (allOf 2) | JSON | All variants apply | Status of the Budget e.g. ACTIVE. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date when the Budget should start counting. Format: date |
start_date (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
Get transfer — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Format: int64 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | The type of currency, in ISO 4217 format. Default: USD |
currency (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.budgets_getspendbudgetbyid. Catalog operation: budgets:getSpendBudgetById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["budgets", "budgets.readonly"]