Brex: Get Budget Program
Brex budgets.budgetsGetBudgetProgramById: arguments, response, policy and SDK examples.
← Budgets operations · Get started
Operation brex.budgets_getbudgetprogrambyid
Provider route: GET /v1/budget_programs/{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"]["budgetsGetBudgetProgramById"]>[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.budgetsGetBudgetProgramById(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_budget_program_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 Program — response body |
Referenced models: Get Budget Program — response body
Schemas
Section titled “Schemas”Get Budget Program — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Budget Program used to create Spend Limits for eligible users. |
budget_blueprints | array | Required within parent | |
budget_blueprints[] | Model | Each item | Expand Get Budget Program — response body — budget blueprints item |
budget_program_status | string | Required within parent | Known values: BUDGET_PROGRAM_STATUS_ACTIVE, BUDGET_PROGRAM_STATUS_INACTIVE, BUDGET_PROGRAM_STATUS_DELETED |
created_at | string | Required within parent | Format: date |
creator_user_id | JSON | Optional | |
creator_user_id (anyOf 1) | string | Alternative | |
creator_user_id (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
employee_filter | JSON | Optional | |
employee_filter (anyOf 1) | JSON | Alternative | |
employee_filter (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Budget Program — response body — employee filter employment status, employment type employment status, employment type |
employee_filter (anyOf 2) | null | Alternative | |
existing_budget_ids | JSON | Optional | |
existing_budget_ids (anyOf 1) | array | Alternative | IDs for existing Spend Limits associated with this Budget Program. |
existing_budget_ids (anyOf 1)[] | string | Each item | |
existing_budget_ids (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | string | Required within parent | |
updated_at | string | Required within parent | Format: date |
Referenced models: Get Budget Program — response body — budget blueprints item, Get Budget Program — response body — employee filter employment status, employment type employment status, employment type
Get Budget Program — response body — budget blueprints item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blueprint for provisioning Spend Limits for a Budget Program. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of what the Spend Limit is used for. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The UTC date when the Spend Limit should stop counting. Format: date |
end_date (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
limit | JSON | Optional | |
limit (anyOf 1) | JSON | Alternative | |
limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
limit (anyOf 2) | null | Alternative | |
limit_type | string | Required within parent | Whether the Spend Limit's limit blocks spend. Known values: HARD, SOFT |
limit_visibility | string | Required within parent | Determines if Spend Limit members are allowed to view the Spend Limit's limit. Known values: SHARED, PRIVATE |
name | string | Required within parent | Name for the Spend Limit. |
owner_user_ids | array | Required within parent | User IDs of the owners of the Spend Limit. |
owner_user_ids[] | string | Each item | |
parent_budget_id | string | Required within parent | ID of parent Budget. |
period_type | string | Required within parent | Period type of the Spend Limit e.g. MONTHLY. Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
spend_type | string | Required within parent | Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. Known values: BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The UTC date when the Spend Limit should start counting. Format: date |
start_date (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
Get Budget Program — response body — employee filter employment status, employment type employment status, employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A filter used to determine if a user adheres to a Budget Program. |
employment_status | JSON | Optional | |
employment_status (anyOf 1) | JSON | Alternative | |
employment_status (anyOf 1) (allOf 1) | string | All variants apply | A filter used to determine if a user adheres to a Budget Program. Known values: EMPLOYMENT_STATUS_ACTIVE, EMPLOYMENT_STATUS_INACTIVE, EMPLOYMENT_STATUS_PENDING |
employment_status (anyOf 2) | null | Alternative | |
employment_type | JSON | Optional | |
employment_type (anyOf 1) | JSON | Alternative | |
employment_type (anyOf 1) (allOf 1) | string | All variants apply | What kind of employment the employee has. Known values: EMPLOYMENT_TYPE_FULL_TIME, EMPLOYMENT_TYPE_PART_TIME, EMPLOYMENT_TYPE_CONTRACTOR, EMPLOYMENT_TYPE_INTERN, EMPLOYMENT_TYPE_FREELANCE |
employment_type (anyOf 2) | null | Alternative |
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_getbudgetprogrambyid. Catalog operation: budgets:getBudgetProgramById. 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"]