Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorJSONOptional
query.cursor (anyOf 1)stringAlternative
query.cursor (anyOf 2)nullAlternative
query.limitJSONOptional
query.limit (anyOf 1)integerAlternativeFormat: int32
query.limit (anyOf 2)nullAlternative

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List Spend Limits — budgets budgets List Budgets — response body

Referenced models: List Spend Limits — budgets budgets List Budgets — response body

List Spend Limits — budgets budgets List Budgets — response body
FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get Spend Limit — budgets budgets Get Budget By Id — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get Spend Limit — budgets budgets Get Budget By Id — response body

Get Spend Limit — budgets budgets Get Budget By Id — response body
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringRequired within parent
The Brex account this Spend Limit belongs to.
budget_idstringRequired within parent
Unique ID for the Spend Limit.
budget_statusstringRequired within parent
Status of the Spend Limit e.g. APPROVED.

Known values: APPROVED, EXPIRED, TERMINATED, DELETED
budget_typeJSONRequired within parent
budget_type (allOf 1)stringAll variants apply
Whether this is a Budget or a Spend Limit for post-bifurcation entities.

Known values: BUDGET, SPEND_LIMIT
budget_type (allOf 2)JSONAll variants apply
Whether this is a Budget or a Spend Limit for post-bifurcation entities.
creator_user_idJSONOptional
creator_user_id (anyOf 1)stringAlternative
The ID of the user who originally created this Spend Limit.
creator_user_id (anyOf 2)nullAlternative
current_period_balanceJSONOptional
current_period_balance (anyOf 1)JSONAlternative
current_period_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
Description of what the Spend Limit is used for.
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternative
The UTC date when the Spend Limit should stop counting.

Format: date
end_date (anyOf 2)nullAlternative
limitJSONOptional
limit (anyOf 1)JSONAlternative
limit (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
limit (anyOf 2)nullAlternative
limit_typeJSONOptional
limit_type (anyOf 1)JSONAlternative
limit_type (anyOf 1) (allOf 1)stringAll variants apply
Whether the Spend Limit's limit blocks spend.

Known values: HARD, SOFT
limit_type (anyOf 2)nullAlternative
limit_visibilityJSONRequired within parent
limit_visibility (allOf 1)stringAll variants apply
Determines if Spend Limit members are allowed to view the Spend Limit's limit.

Known values: SHARED, PRIVATE
limit_visibility (allOf 2)JSONAll variants apply
Determines if Spend Limit members are allowed to view the Spend Limit's limit.
member_user_idsarrayRequired within parent
User IDs of the members of the Spend Limit.
member_user_ids[]stringEach item
namestringRequired within parent
Name for the Spend Limit.
owner_user_idsarrayRequired within parent
User IDs of the owners of the Spend Limit.
owner_user_ids[]stringEach item
parent_budget_idJSONOptional
parent_budget_id (anyOf 1)stringAlternative
ID of parent Budget.
parent_budget_id (anyOf 2)nullAlternative
period_typestringRequired within parent
Period type of the Spend Limit e.g. MONTHLY.

Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME
spend_typestringRequired 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_dateJSONOptional
start_date (anyOf 1)stringAlternative
The UTC date when the Spend Limit should start counting.

Format: date
start_date (anyOf 2)nullAlternative
templateIdJSONOptional
templateId (anyOf 1)stringAlternative
templateId (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
Current Spend Limit period balance.
balanceJSONOptional
balance (anyOf 1)JSONAlternative
balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
balance (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeFormat: date
end_date (anyOf 2)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeFormat: date
start_date (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount

Get transfer — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
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.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.