Sign in
latestOpenAPI 3.0.12026-08-08175166.0 KB

e93b1cd07aaf

Spend Limits (v2)

Get Spend Limit

Retrieves a Spend Limit by ID

get/v2/spend_limits/{id}

Path parameters

idstring required

Response

The Spend Limit that was retrieved

idstring required

Unique ID for the Spend Limit.

account_idstring required

The Brex account this Spend Limit belongs to.

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.

status'ACTIVE' | 'EXPIRED' | 'ARCHIVED' | 'DELETED' required

Status of the Spend Limit e.g. ACTIVE.

period_recurrence_type'PER_WEEK' | 'PER_MONTH' | 'PER_QUARTER' | 'PER_YEAR' | 'ONE_TIME' required

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

start_datestring date nullable

The date when the Spend Limit should start counting.

end_datestring date nullable

The date when the Spend Limit should expire.

start_time_utcstring date-time nullable

The UTC time when the Spend Limit should start counting.

end_time_utcstring date-time nullable

The UTC time when the Spend Limit should expire.

expense_visibility'SHARED' | 'PRIVATE' required

Whether or not expense related to this Spend Limit should be viewable to all members.

authorization_visibility'PUBLIC' | 'PRIVATE' required

Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral).

limit_increase_setting'ENABLED' | 'DISABLED' required

Whether or not members can request limit increases.

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.

auto_transfer_cards_setting'DISABLED' | 'ENABLED' required

Setting for how auto transfer works for virtual cards.

auto_create_limit_cards_setting'DISABLED' | 'ALL_MEMBERS' required

Setting for how auto limit card creation works for members.

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.

expense_policy_idstring required

The ID of the expense policy corresponding to this Spend Limit.

limit_increase_request_policy_idstring nullable

The ID of the policy for limit increase requests for this Spend Limit.

limit_approval_policy_idstring nullable

The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.

legal_entity_idstring nullable

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.

department_idstring nullable

The department ID to which Spend Limit expenses will be attributed.

Example response

{
  "authorization_settings": {
    "base_limit": {
      "amount": 700,
      "currency": "USD"
    },
    "limit_with_increases": {
      "amount": 700,
      "currency": "USD"
    }
  },
  "transaction_limit": {
    "amount": 700,
    "currency": "USD"
  },
  "current_period_balance": {
    "amount_spent": {
      "amount": 700,
      "currency": "USD"
    },
    "rollover_amount": {
      "amount": 700,
      "currency": "USD"
    }
  }
}