BRbrex-com
Spend Limits (v1)

Get Spend Limit

Retrieves a Spend Limit by ID

get/v1/budgets/{id}

Request

  • Base URL
    https://api.brex.com
  • Auth
    OAuth 2
    Authorization codehttps://accounts-api.brex.com/oauth2/default/v1/authorize
    Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
    Scopesbudgets.readonly, budgets
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Response

The Spend Limit that was retrieved

budget_idstring required

Unique ID for the Spend Limit.

account_idstring required

The Brex account this Spend Limit belongs to.

creator_user_idstring nullable

The ID of the user who originally created this Spend Limit.

namestring required

Name for the Spend Limit.

descriptionstring nullable

Description of what the Spend Limit is used for.

parent_budget_idstring nullable

ID of parent Budget.

owner_user_idsstring[] required

User IDs of the owners of the Spend Limit.

member_user_idsstring[] required

User IDs of the members of the Spend Limit.

period_type'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' | 'ONE_TIME' required

Period type of the Spend Limit e.g. MONTHLY.

start_datestring date nullable

The UTC date when the Spend Limit should start counting.

end_datestring date nullable

The UTC date when the Spend Limit should stop counting.

budget_status'APPROVED' | 'EXPIRED' | 'TERMINATED' | 'DELETED' required

Status of the Spend Limit e.g. APPROVED.

limit_type'HARD' | 'SOFT'

Whether the Spend Limit's limit blocks spend.

spend_type'BUDGET_PROVISIONED_CARDS_ONLY' | 'NON_BUDGET_PROVISIONED_CARDS_ALLOWED' required

Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit.

limit_visibility'SHARED' | 'PRIVATE' required

Determines if Spend Limit members are allowed to view the Spend Limit's limit.

templateIdstring nullable
budget_type'BUDGET' | 'SPEND_LIMIT' required

Whether this is a Budget or a Spend Limit for post-bifurcation entities.

Example response

{
  "limit": {
    "amount": 700,
    "currency": "USD"
  },
  "current_period_balance": {
    "balance": {
      "amount": 700,
      "currency": "USD"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.