Brex: List Spend Limits — budgets budgets List Budgets
Brex budgets.budgetsListBudgets: arguments, response, policy and SDK examples.
← Budgets operations · Get started
Operation brex.budgets_listbudgets
Provider route: GET /v1/budgets. 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"]["budgetsListBudgets"]>[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.budgetsListBudgets(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_list_budgets(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | JSON | Optional | |
query.cursor (anyOf 1) | string | Alternative | |
query.cursor (anyOf 2) | null | Alternative | |
query.limit | JSON | Optional | |
query.limit (anyOf 1) | integer | Alternative | Format: int32 |
query.limit (anyOf 2) | null | Alternative |
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 List Spend Limits — budgets budgets List Budgets — response body |
Referenced models: List Spend Limits — budgets budgets List Budgets — response body
Schemas
Section titled “Schemas”List Spend Limits — budgets budgets List Budgets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Spend Limit — budgets budgets Get Budget By Id — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Spend Limit — budgets budgets Get Budget By Id — response body
Get Spend Limit — budgets budgets Get Budget By Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Required within parent | The Brex account this Spend Limit belongs to. |
budget_id | string | Required within parent | Unique ID for the Spend Limit. |
budget_status | string | Required within parent | Status of the Spend Limit e.g. APPROVED. Known values: APPROVED, EXPIRED, TERMINATED, DELETED |
budget_type | JSON | Required within parent | |
budget_type (allOf 1) | string | All variants apply | Whether this is a Budget or a Spend Limit for post-bifurcation entities. Known values: BUDGET, SPEND_LIMIT |
budget_type (allOf 2) | JSON | All variants apply | Whether this is a Budget or a Spend Limit for post-bifurcation entities. |
creator_user_id | JSON | Optional | |
creator_user_id (anyOf 1) | string | Alternative | The ID of the user who originally created this Spend Limit. |
creator_user_id (anyOf 2) | null | Alternative | |
current_period_balance | JSON | Optional | |
current_period_balance (anyOf 1) | JSON | Alternative | |
current_period_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Spend Limit — budgets budgets Get Budget By Id — response body — current period balance balance, end date, start date balance, end date, start date |
current_period_balance (anyOf 2) | null | Alternative | |
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 | |
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 | JSON | Optional | |
limit_type (anyOf 1) | JSON | Alternative | |
limit_type (anyOf 1) (allOf 1) | string | All variants apply | Whether the Spend Limit's limit blocks spend. Known values: HARD, SOFT |
limit_type (anyOf 2) | null | Alternative | |
limit_visibility | JSON | Required within parent | |
limit_visibility (allOf 1) | string | All variants apply | Determines if Spend Limit members are allowed to view the Spend Limit's limit. Known values: SHARED, PRIVATE |
limit_visibility (allOf 2) | JSON | All variants apply | Determines if Spend Limit members are allowed to view the Spend Limit's limit. |
member_user_ids | array | Required within parent | User IDs of the members of the Spend Limit. |
member_user_ids[] | string | Each item | |
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 | JSON | Optional | |
parent_budget_id (anyOf 1) | string | Alternative | ID of parent Budget. |
parent_budget_id (anyOf 2) | null | Alternative | |
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 | |
templateId | JSON | Optional | |
templateId (anyOf 1) | string | Alternative | |
templateId (anyOf 2) | null | Alternative |
Referenced models: Get Spend Limit — budgets budgets Get Budget By Id — response body — current period balance balance, end date, start date balance, end date, start date, Get transfer — response body — amount
Get Spend Limit — budgets budgets Get Budget By Id — response body — current period balance balance, end date, start date balance, end date, start date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current Spend Limit period balance. |
balance | JSON | Optional | |
balance (anyOf 1) | JSON | Alternative | |
balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
balance (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Format: date |
end_date (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | 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_listbudgets. Catalog operation: budgets:listBudgets. 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"]