Skip to content

Brex: List Spend Limits — budgets budgets List Spend Limits

Brex budgets.budgetsListSpendLimits: arguments, response, policy and SDK examples.

← Budgets operations · Get started

Operation brex.budgets_listspendlimits

Provider route: GET /v2/spend_limits. 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"]["budgetsListSpendLimits"]>[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.budgetsListSpendLimits(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_spend_limits(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
query.member_user_id[]JSONOptional
query.member_user_id[] (anyOf 1)arrayAlternative
Filter for spend limits these user ids are members of.
query.member_user_id[] (anyOf 1)[]stringEach item
query.member_user_id[] (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 Spend Limits — response body

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

5 more schemas are linked from the tables above, on the schema pages.

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

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

Get Spend Limit — budgets budgets Get Spend Limit By Id — response body
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringRequired within parent
The Brex account this Spend Limit belongs to.
authorization_settingsJSONOptional
authorization_settings (anyOf 1)JSONAlternative
authorization_settings (anyOf 1) (allOf 1)ModelAll variants applyExpand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — authorization settings authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate
authorization_settings (anyOf 1) (allOf 2)JSONAll variants apply
Spend authorization settings.
authorization_settings (anyOf 2)nullAlternative
authorization_visibilityJSONRequired within parent
authorization_visibility (allOf 1)stringAll variants apply
Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral).

Known values: PUBLIC, PRIVATE
authorization_visibility (allOf 2)JSONAll variants apply
Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral).
auto_create_limit_cards_settingJSONRequired within parent
auto_create_limit_cards_setting (allOf 1)stringAll variants apply
Setting for how auto limit card creation works for members.

Known values: DISABLED, ALL_MEMBERS
auto_create_limit_cards_setting (allOf 2)JSONAll variants apply
Setting for how auto limit card creation works for members.
auto_transfer_cards_settingJSONRequired within parent
auto_transfer_cards_setting (allOf 1)stringAll variants apply
Setting for how auto transfer works for virtual cards.

Known values: DISABLED, ENABLED
auto_transfer_cards_setting (allOf 2)JSONAll variants apply
Setting for how auto transfer works for virtual cards.
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 Spend Limit By Id — response body — current period balance amount spent, end date, end time, rollover amount, start date, start time amount spent, end date, end time, rollover amount, start date, start time
current_period_balance (anyOf 2)nullAlternative
department_idJSONOptional
department_id (anyOf 1)stringAlternative
The department ID to which Spend Limit expenses will be attributed.
department_id (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 date when the Spend Limit should expire.

Format: date
end_date (anyOf 2)nullAlternative
end_time_utcJSONOptional
end_time_utc (anyOf 1)stringAlternative
The UTC time when the Spend Limit should expire.

Format: date-time
end_time_utc (anyOf 2)nullAlternative
expense_policy_idstringRequired within parent
The ID of the expense policy corresponding to this Spend Limit.
expense_visibilityJSONRequired within parent
expense_visibility (allOf 1)stringAll variants apply
Whether or not expense related to this Spend Limit should be viewable to all members.

Known values: SHARED, PRIVATE
expense_visibility (allOf 2)JSONAll variants apply
Whether or not expense related to this Spend Limit should be viewable to all members.
idstringRequired within parent
Unique ID for the Spend Limit.
legal_entity_idJSONOptional
legal_entity_id (anyOf 1)stringAlternative
The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user's entity.
legal_entity_id (anyOf 2)nullAlternative
limit_approval_policy_idJSONOptional
limit_approval_policy_id (anyOf 1)stringAlternative
The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.
limit_approval_policy_id (anyOf 2)nullAlternative
limit_increase_request_policy_idJSONOptional
limit_increase_request_policy_id (anyOf 1)stringAlternative
The ID of the policy for limit increase requests for this Spend Limit.
limit_increase_request_policy_id (anyOf 2)nullAlternative
limit_increase_settingJSONRequired within parent
limit_increase_setting (allOf 1)stringAll variants apply
Whether or not members can request limit increases.

Known values: ENABLED, DISABLED
limit_increase_setting (allOf 2)JSONAll variants apply
Whether or not members can request limit increases.
member_user_idsarrayRequired within parent
User IDs of the members of the Spend Limit.
member_user_ids[]stringEach item
merchant_category_controlsJSONOptional
merchant_category_controls (anyOf 1)JSONAlternative
merchant_category_controls (anyOf 1) (allOf 1)ModelAll variants applyExpand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories
merchant_category_controls (anyOf 1) (allOf 2)JSONAll variants apply
The Spend Limit's merchant category controls.
merchant_category_controls (anyOf 2)nullAlternative
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_recurrence_typeJSONRequired within parent
period_recurrence_type (allOf 1)stringAll variants apply
Period type of the Spend Limit e.g. MONTHLY.

Known values: PER_WEEK, PER_MONTH, PER_QUARTER, PER_YEAR, ONE_TIME
period_recurrence_type (allOf 2)JSONAll variants apply
Period type of the Spend Limit e.g. MONTHLY.
spend_typeJSONRequired within parent
spend_type (allOf 1)stringAll variants apply
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
spend_type (allOf 2)JSONAll variants apply
Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit.
start_dateJSONOptional
start_date (anyOf 1)stringAlternative
The date when the Spend Limit should start counting.

Format: date
start_date (anyOf 2)nullAlternative
start_time_utcJSONOptional
start_time_utc (anyOf 1)stringAlternative
The UTC time when the Spend Limit should start counting.

Format: date-time
start_time_utc (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants apply
Status of the Spend Limit e.g. ACTIVE.

Known values: ACTIVE, EXPIRED, ARCHIVED, DELETED
status (allOf 2)JSONAll variants apply
Status of the Spend Limit e.g. ACTIVE.
transaction_limitJSONOptional
transaction_limit (anyOf 1)JSONAlternative
transaction_limit (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
transaction_limit (anyOf 1) (allOf 2)JSONAll variants apply
The transaction limit that this Spend Limit will enforce.
transaction_limit (anyOf 2)nullAlternative

Referenced models: Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — authorization settings authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate, Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories, Get transfer — response body — amount, Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — current period balance amount spent, end date, end time, rollover amount, start date, start time amount spent, end date, end time, rollover amount, start date, start time

SDK function policy ID: brex.budgets_listspendlimits. Catalog operation: budgets:listSpendLimits. 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.