Tool to create a new Spend Limit (Budget) in Brex. Use when you need to set up spending controls with specific limits, visibility settings, and period types.
nameRequiredstringName for the Spend Limit.
limitRequiredobjectThe spending limit amount and currency for this budget.
end_datestringThe UTC date when the Spend Limit should stop counting, in YYYY-MM-DD format.
entity_idstringOptional entity ID to associate with this budget.
policy_idstringOptional policy ID to associate with this budget.
limit_typeRequiredstringWhether the Spend Limit's limit blocks spend. HARD limits block transactions when exceeded, SOFT limits allow overspending but provide warnings.
spend_typeRequiredstringWhether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. BUDGET_PROVISIONED_CARDS_ONLY restricts spending to cards created under this budget, while NON_BUDGET_PROVISIONED_CARDS_ALLOWED permits other cards to use this budget.
start_datestringThe UTC date when the Spend Limit should start counting, in YYYY-MM-DD format.
descriptionRequiredstringDescription of what the Spend Limit is used for.
period_typeRequiredstringPeriod type of the Spend Limit. Options: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME.
owner_user_idsarrayUser IDs of the owners of the Spend Limit. Owners have full control over the budget.
idempotency_keystringIdempotency key for the request. For retry safety, clients should generate, store, and reuse the same key when retrying failed operations. If not provided, a UUID will be auto-generated. Recommended format: V4 UUID.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.