BudgetsPaths

Defined in: src/budgets/types.gen.ts:2

Properties

/v1/budget_programs

/v1/budget_programs: object

Defined in: src/budgets/types.gen.ts:3

delete?

optional delete?: undefined

get

get: object

List Budget Programs

Description

Lists Budget Programs belonging to this account

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

A page with a list of Budget Programs

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v1/budget_programs/{id}

/v1/budget_programs/{id}: object

Defined in: src/budgets/types.gen.ts:23

delete?

optional delete?: undefined

get

get: object

Get Budget Program

Description

Retrieves a Budget Program by ID

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

The Budget Program that was retrieved

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.budget_blueprints

budget_blueprints: object[]

get.responses.200.content.application/json.budget_program_status

budget_program_status: "BUDGET_PROGRAM_STATUS_ACTIVE" | "BUDGET_PROGRAM_STATUS_INACTIVE" | "BUDGET_PROGRAM_STATUS_DELETED"

get.responses.200.content.application/json.created_at

created_at: string

Format: date

get.responses.200.content.application/json.creator_user_id?

optional creator_user_id?: string | null

get.responses.200.content.application/json.description?

optional description?: string | null

get.responses.200.content.application/json.employee_filter?

optional employee_filter?: { employment_status?: "EMPLOYMENT_STATUS_ACTIVE" | "EMPLOYMENT_STATUS_INACTIVE" | "EMPLOYMENT_STATUS_PENDING" | null; employment_type?: "EMPLOYMENT_TYPE_FULL_TIME" | "EMPLOYMENT_TYPE_PART_TIME" | "EMPLOYMENT_TYPE_CONTRACTOR" | "EMPLOYMENT_TYPE_INTERN" | "EMPLOYMENT_TYPE_FREELANCE" | null; } | null

get.responses.200.content.application/json.existing_budget_ids?

optional existing_budget_ids?: string[] | null

Description

IDs for existing Spend Limits associated with this Budget Program.

get.responses.200.content.application/json.id

id: string

get.responses.200.content.application/json.name

name: string

get.responses.200.content.application/json.updated_at

updated_at: string

Format: date

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Not Found

get.responses.404.content?

optional content?: undefined

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v1/budgets

/v1/budgets: object

Defined in: src/budgets/types.gen.ts:43

delete?

optional delete?: undefined

get

get: object

List Spend Limits

Description

Lists Spend Limits belonging to this account

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

A page with a list of Spend Limits

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Create Spend Limit

Description

Creates a Spend Limit

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header

header: object

post.parameters.header.Idempotency-Key

Idempotency-Key: string

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.description

description: string

Description

Description of what the Spend Limit is used for.

post.requestBody.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should stop counting.

post.requestBody.content.application/json.entity_id?

optional entity_id?: string | null

post.requestBody.content.application/json.limit

limit: object

post.requestBody.content.application/json.limit.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

post.requestBody.content.application/json.limit.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

post.requestBody.content.application/json.limit_type

limit_type: "HARD" | "SOFT"

post.requestBody.content.application/json.limit_visibility

limit_visibility: "PRIVATE" | "SHARED"

post.requestBody.content.application/json.member_user_ids?

optional member_user_ids?: string[] | null

Description

User IDs of the members of the Spend Limit.

post.requestBody.content.application/json.name

name: string

Description

Name for the Spend Limit.

post.requestBody.content.application/json.owner_user_ids?

optional owner_user_ids?: string[] | null

Description

User IDs of the owners of the Spend Limit.

post.requestBody.content.application/json.parent_budget_id

parent_budget_id: string

Description

ID of parent Budget.

post.requestBody.content.application/json.period_type

period_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

post.requestBody.content.application/json.policy_id?

optional policy_id?: string | null

post.requestBody.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

post.requestBody.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should start counting.

post.responses

responses: object

post.responses.200

200: object

Description

The Spend Limit that was created

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Spend Limit belongs to.

post.responses.200.content.application/json.budget_id

budget_id: string

Description

Unique ID for the Spend Limit.

post.responses.200.content.application/json.budget_status

budget_status: "DELETED" | "APPROVED" | "EXPIRED" | "TERMINATED"

post.responses.200.content.application/json.budget_type

budget_type: "BUDGET" | "SPEND_LIMIT"

post.responses.200.content.application/json.creator_user_id?

optional creator_user_id?: string | null

Description

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

post.responses.200.content.application/json.current_period_balance?

optional current_period_balance?: { balance?: { amount: number; currency: … | …; } | null; end_date?: string | null; start_date?: string | null; } | null

Union Members

Type Literal

{ balance?: { amount: number; currency: … | …; } | null; end_date?: string | null; start_date?: string | null; }

balance?

optional balance?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

end_date?

optional end_date?: string | null

Format: date

start_date?

optional start_date?: string | null

Format: date

---

null

post.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

post.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should stop counting.

post.responses.200.content.application/json.limit?

optional limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

post.responses.200.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

post.responses.200.content.application/json.limit_visibility

limit_visibility: "PRIVATE" | "SHARED"

post.responses.200.content.application/json.member_user_ids

member_user_ids: string[]

Description

User IDs of the members of the Spend Limit.

post.responses.200.content.application/json.name

name: string

Description

Name for the Spend Limit.

post.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Spend Limit.

post.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

post.responses.200.content.application/json.period_type

period_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

post.responses.200.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

post.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should start counting.

post.responses.200.content.application/json.templateId?

optional templateId?: string | null

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content?

optional content?: undefined

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content?

optional content?: undefined

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content?

optional content?: undefined

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v1/budgets/{id}

/v1/budgets/{id}: object

Defined in: src/budgets/types.gen.ts:67

delete?

optional delete?: undefined

get

get: object

Get Spend Limit

Description

Retrieves a Spend Limit by ID

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

The Spend Limit that was retrieved

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Spend Limit belongs to.

get.responses.200.content.application/json.budget_id

budget_id: string

Description

Unique ID for the Spend Limit.

get.responses.200.content.application/json.budget_status

budget_status: "DELETED" | "APPROVED" | "EXPIRED" | "TERMINATED"

get.responses.200.content.application/json.budget_type

budget_type: "BUDGET" | "SPEND_LIMIT"

get.responses.200.content.application/json.creator_user_id?

optional creator_user_id?: string | null

Description

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

get.responses.200.content.application/json.current_period_balance?

optional current_period_balance?: { balance?: { amount: number; currency: … | …; } | null; end_date?: string | null; start_date?: string | null; } | null

Union Members

Type Literal

{ balance?: { amount: number; currency: … | …; } | null; end_date?: string | null; start_date?: string | null; }

balance?

optional balance?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

end_date?

optional end_date?: string | null

Format: date

start_date?

optional start_date?: string | null

Format: date

---

null

get.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

get.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should stop counting.

get.responses.200.content.application/json.limit?

optional limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

get.responses.200.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

get.responses.200.content.application/json.limit_visibility

limit_visibility: "PRIVATE" | "SHARED"

get.responses.200.content.application/json.member_user_ids

member_user_ids: string[]

Description

User IDs of the members of the Spend Limit.

get.responses.200.content.application/json.name

name: string

Description

Name for the Spend Limit.

get.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Spend Limit.

get.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

get.responses.200.content.application/json.period_type

period_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

get.responses.200.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

get.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should start counting.

get.responses.200.content.application/json.templateId?

optional templateId?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Not Found

get.responses.404.content?

optional content?: undefined

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put

put: object

Update Spend Limit

Description

Updates a Spend Limit

put.parameters

parameters: object

put.parameters.cookie?

optional cookie?: undefined

put.parameters.header

header: object

put.parameters.header.Idempotency-Key

Idempotency-Key: string

put.parameters.path

path: object

put.parameters.path.id

id: string

put.parameters.query?

optional query?: undefined

put.requestBody

requestBody: object

put.requestBody.content

content: object

put.requestBody.content.application/json

application/json: object

put.requestBody.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

put.requestBody.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should stop counting.

put.requestBody.content.application/json.limit?

optional limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

put.requestBody.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

put.requestBody.content.application/json.limit_visibility?

optional limit_visibility?: "PRIVATE" | "SHARED" | null

put.requestBody.content.application/json.member_user_ids?

optional member_user_ids?: string[] | null

Description

User IDs of the members of the Spend Limit.

put.requestBody.content.application/json.name?

optional name?: string | null

Description

Name for the Spend Limit.

put.requestBody.content.application/json.owner_user_ids?

optional owner_user_ids?: string[] | null

Description

User IDs of the owners of the Spend Limit.

put.requestBody.content.application/json.period_type?

optional period_type?: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null

put.requestBody.content.application/json.spend_type?

optional spend_type?: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED" | null

put.requestBody.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should start counting.

put.responses

responses: object

put.responses.200

200: object

Description

The Spend Limit that was updated

put.responses.200.content

content: object

put.responses.200.content.application/json

application/json: object

put.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Spend Limit belongs to.

put.responses.200.content.application/json.budget_id

budget_id: string

Description

Unique ID for the Spend Limit.

put.responses.200.content.application/json.budget_status

budget_status: "DELETED" | "APPROVED" | "EXPIRED" | "TERMINATED"

put.responses.200.content.application/json.budget_type

budget_type: "BUDGET" | "SPEND_LIMIT"

put.responses.200.content.application/json.creator_user_id?

optional creator_user_id?: string | null

Description

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

put.responses.200.content.application/json.current_period_balance?

optional current_period_balance?: { balance?: { amount: number; currency: … | …; } | null; end_date?: string | null; start_date?: string | null; } | null

Union Members

Type Literal

{ balance?: { amount: number; currency: … | …; } | null; end_date?: string | null; start_date?: string | null; }

balance?

optional balance?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

end_date?

optional end_date?: string | null

Format: date

start_date?

optional start_date?: string | null

Format: date

---

null

put.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

put.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should stop counting.

put.responses.200.content.application/json.limit?

optional limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

put.responses.200.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

put.responses.200.content.application/json.limit_visibility

limit_visibility: "PRIVATE" | "SHARED"

put.responses.200.content.application/json.member_user_ids

member_user_ids: string[]

Description

User IDs of the members of the Spend Limit.

put.responses.200.content.application/json.name

name: string

Description

Name for the Spend Limit.

put.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Spend Limit.

put.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

put.responses.200.content.application/json.period_type

period_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

put.responses.200.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

put.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The UTC date when the Spend Limit should start counting.

put.responses.200.content.application/json.templateId?

optional templateId?: string | null

put.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.400

400: object

Description

Bad request

put.responses.400.content?

optional content?: undefined

put.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.401

401: object

Description

Unauthorized

put.responses.401.content?

optional content?: undefined

put.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.403

403: object

Description

Forbidden

put.responses.403.content?

optional content?: undefined

put.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.404

404: object

Description

Not Found

put.responses.404.content?

optional content?: undefined

put.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

trace?

optional trace?: undefined

---

/v1/budgets/{id}/archive

/v1/budgets/{id}/archive: object

Defined in: src/budgets/types.gen.ts:91

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Archive a Spend Limit

Description

Archives a Spend Limit, making it unusable for future expenses and removing it from the UI

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path

path: object

post.parameters.path.id

id: string

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

The Spend Limit that was archived

post.responses.200.content?

optional content?: undefined

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content?

optional content?: undefined

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content?

optional content?: undefined

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content?

optional content?: undefined

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.404

404: object

Description

Not Found

post.responses.404.content?

optional content?: undefined

post.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v2/budgets

/v2/budgets: object

Defined in: src/budgets/types.gen.ts:111

delete?

optional delete?: undefined

get

get: object

List Budgets

Description

Retrieves a list of Budgets

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

A page with a list of Budgets

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Not Found

get.responses.404.content?

optional content?: undefined

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Create Budget

Description

Creates a Budget

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header

header: object

post.parameters.header.Idempotency-Key

Idempotency-Key: string

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.amount

amount: object

post.requestBody.content.application/json.amount.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

post.requestBody.content.application/json.amount.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

post.requestBody.content.application/json.description

description: string

Description

Description of what the Budget is used for.

post.requestBody.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Budget should stop counting.

post.requestBody.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

Deprecated

This API is no longer supported and may be removed in a future release.

post.requestBody.content.application/json.name

name: string

Description

Name for the Budget.

post.requestBody.content.application/json.owner_user_ids?

optional owner_user_ids?: string[] | null

Description

User IDs of the owners of the Budget.

post.requestBody.content.application/json.parent_budget_id

parent_budget_id: string

Description

ID of parent Budget.

post.requestBody.content.application/json.period_recurrence_type

period_recurrence_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

post.requestBody.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Budget should start counting.

post.responses

responses: object

post.responses.200

200: object

Description

The Budget that was created

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Budget belongs to.

post.responses.200.content.application/json.amount?

optional amount?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

post.responses.200.content.application/json.budget_id

budget_id: string

Description

Unique ID for the Budget.

post.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Budget is used for.

post.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Budget should stop counting.

post.responses.200.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

Deprecated

This API is no longer supported and may be removed in a future release.

post.responses.200.content.application/json.name

name: string

Description

Name for the Budget.

post.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Budget.

post.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

post.responses.200.content.application/json.period_recurrence_type

period_recurrence_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

post.responses.200.content.application/json.spend_budget_status

spend_budget_status: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED"

post.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Budget should start counting.

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content?

optional content?: undefined

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content?

optional content?: undefined

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content?

optional content?: undefined

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v2/budgets/{id}

/v2/budgets/{id}: object

Defined in: src/budgets/types.gen.ts:135

delete?

optional delete?: undefined

get

get: object

Get Budget

Description

Retrieves a Budget by ID

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

The Budget that was retrieved

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Budget belongs to.

get.responses.200.content.application/json.amount?

optional amount?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

get.responses.200.content.application/json.budget_id

budget_id: string

Description

Unique ID for the Budget.

get.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Budget is used for.

get.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Budget should stop counting.

get.responses.200.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

Deprecated

This API is no longer supported and may be removed in a future release.

get.responses.200.content.application/json.name

name: string

Description

Name for the Budget.

get.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Budget.

get.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

get.responses.200.content.application/json.period_recurrence_type

period_recurrence_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

get.responses.200.content.application/json.spend_budget_status

spend_budget_status: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED"

get.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Budget should start counting.

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Not Found

get.responses.404.content?

optional content?: undefined

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put

put: object

Update Budget

Description

Updates a Budget

put.parameters

parameters: object

put.parameters.cookie?

optional cookie?: undefined

put.parameters.header

header: object

put.parameters.header.Idempotency-Key

Idempotency-Key: string

put.parameters.path

path: object

put.parameters.path.id

id: string

put.parameters.query?

optional query?: undefined

put.requestBody

requestBody: object

put.requestBody.content

content: object

put.requestBody.content.application/json

application/json: object

put.requestBody.content.application/json.amount?

optional amount?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

put.requestBody.content.application/json.description?

optional description?: string | null

Description

Description of what the Budget is used for.

put.requestBody.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Budget should stop counting.

put.requestBody.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

Deprecated

This API is no longer supported and may be removed in a future release.

put.requestBody.content.application/json.name?

optional name?: string | null

Description

Name for the Budget.

put.requestBody.content.application/json.owner_user_ids?

optional owner_user_ids?: string[] | null

Description

User IDs of the owners of the Budget.

put.requestBody.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

put.requestBody.content.application/json.period_recurrence_type?

optional period_recurrence_type?: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null

put.requestBody.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Budget should start counting.

put.responses

responses: object

put.responses.200

200: object

Description

The Budget that was updated

put.responses.200.content

content: object

put.responses.200.content.application/json

application/json: object

put.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Budget belongs to.

put.responses.200.content.application/json.amount?

optional amount?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

put.responses.200.content.application/json.budget_id

budget_id: string

Description

Unique ID for the Budget.

put.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Budget is used for.

put.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Budget should stop counting.

put.responses.200.content.application/json.limit_type?

optional limit_type?: "HARD" | "SOFT" | null

Deprecated

This API is no longer supported and may be removed in a future release.

put.responses.200.content.application/json.name

name: string

Description

Name for the Budget.

put.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Budget.

put.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

put.responses.200.content.application/json.period_recurrence_type

period_recurrence_type: "WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"

put.responses.200.content.application/json.spend_budget_status

spend_budget_status: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED"

put.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Budget should start counting.

put.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.400

400: object

Description

Bad request

put.responses.400.content?

optional content?: undefined

put.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.401

401: object

Description

Unauthorized

put.responses.401.content?

optional content?: undefined

put.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.403

403: object

Description

Forbidden

put.responses.403.content?

optional content?: undefined

put.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.404

404: object

Description

Not Found

put.responses.404.content?

optional content?: undefined

put.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

trace?

optional trace?: undefined

---

/v2/budgets/{id}/archive

/v2/budgets/{id}/archive: object

Defined in: src/budgets/types.gen.ts:159

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Archive a Budget

Description

Archives a Budget, making any Spend Limits beneath it unusable for future expenses and removing it from the UI

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path

path: object

post.parameters.path.id

id: string

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

The Budget that was archived

post.responses.200.content?

optional content?: undefined

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content?

optional content?: undefined

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content?

optional content?: undefined

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content?

optional content?: undefined

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.404

404: object

Description

Not Found

post.responses.404.content?

optional content?: undefined

post.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v2/spend_limits

/v2/spend_limits: object

Defined in: src/budgets/types.gen.ts:179

delete?

optional delete?: undefined

get

get: object

List Spend Limits

Description

Retrieves a list of Spend Limits

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.parameters.query.member_user_id[]?

optional member_user_id[]?: string[] | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

A page with a list of Spend Limits

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Not Found

get.responses.404.content?

optional content?: undefined

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Create Spend Limit

Description

Creates a Spend Limit

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header

header: object

post.parameters.header.Idempotency-Key

Idempotency-Key: string

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.authorization_settings

authorization_settings: object

post.requestBody.content.application/json.authorization_settings.authorization_type

authorization_type: "HARD" | "SOFT"

post.requestBody.content.application/json.authorization_settings.base_limit

base_limit: object

post.requestBody.content.application/json.authorization_settings.base_limit.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

post.requestBody.content.application/json.authorization_settings.base_limit.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

post.requestBody.content.application/json.authorization_settings.limit_buffer_percentage?

optional limit_buffer_percentage?: number | null

Format: int32

Description

The percentage of flexible buffer on the limit as a 0-100 integer.

post.requestBody.content.application/json.authorization_settings.rollover_refresh_rate

rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"

post.requestBody.content.application/json.authorization_visibility

authorization_visibility: "PUBLIC" | "PRIVATE"

post.requestBody.content.application/json.auto_create_limit_cards_setting

auto_create_limit_cards_setting: "DISABLED" | "ALL_MEMBERS"

post.requestBody.content.application/json.auto_transfer_cards_setting

auto_transfer_cards_setting: "DISABLED" | "ENABLED"

post.requestBody.content.application/json.department_id?

optional department_id?: string | null

Description

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

post.requestBody.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

post.requestBody.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Spend Limit should expire.

post.requestBody.content.application/json.expense_policy_id

expense_policy_id: string

Description

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

post.requestBody.content.application/json.expense_visibility

expense_visibility: "PRIVATE" | "SHARED"

post.requestBody.content.application/json.legal_entity_id?

optional legal_entity_id?: string | null

Description

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.

post.requestBody.content.application/json.limit_approval_policy_id?

optional limit_approval_policy_id?: string | null

Description

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

post.requestBody.content.application/json.limit_increase_request_policy_id?

optional limit_increase_request_policy_id?: string | null

Description

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

post.requestBody.content.application/json.limit_increase_setting

limit_increase_setting: "DISABLED" | "ENABLED"

post.requestBody.content.application/json.member_user_ids?

optional member_user_ids?: string[] | null

Description

User IDs of the members of the Spend Limit.

post.requestBody.content.application/json.name

name: string

Description

Name for the Spend Limit.

post.requestBody.content.application/json.owner_user_ids?

optional owner_user_ids?: string[] | null

Description

User IDs of the owners of the Spend Limit.

post.requestBody.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

post.requestBody.content.application/json.period_recurrence_type

period_recurrence_type: "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | "ONE_TIME" | "PER_WEEK"

post.requestBody.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

post.requestBody.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Spend Limit should start counting.

post.requestBody.content.application/json.transaction_limit?

optional transaction_limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

post.responses

responses: object

post.responses.200

200: object

Description

The Spend Limit that was created

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Spend Limit belongs to.

post.responses.200.content.application/json.authorization_settings?

optional authorization_settings?: { authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; } | null

Union Members

Type Literal

{ authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; }

authorization_type

authorization_type: "HARD" | "SOFT"

base_limit

base_limit: object

base_limit.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

base_limit.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

limit_buffer_percentage?

optional limit_buffer_percentage?: number | null

Format: int32

Description

The percentage of flexible buffer on the limit as a 0-100 integer.

limit_with_increases

limit_with_increases: object

limit_with_increases.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

limit_with_increases.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

rollover_refresh_rate

rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"

---

null

post.responses.200.content.application/json.authorization_visibility

authorization_visibility: "PUBLIC" | "PRIVATE"

post.responses.200.content.application/json.auto_create_limit_cards_setting

auto_create_limit_cards_setting: "DISABLED" | "ALL_MEMBERS"

post.responses.200.content.application/json.auto_transfer_cards_setting

auto_transfer_cards_setting: "DISABLED" | "ENABLED"

post.responses.200.content.application/json.current_period_balance?

optional current_period_balance?: { amount_spent?: { amount: number; currency: … | …; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: … | …; } | null; start_date?: string | null; start_time?: string | null; } | null

Union Members

Type Literal

{ amount_spent?: { amount: number; currency: … | …; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: … | …; } | null; start_date?: string | null; start_time?: string | null; }

amount_spent?

optional amount_spent?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

end_date?

optional end_date?: string | null

Format: date

end_time?

optional end_time?: string | null

Format: date-time

rollover_amount?

optional rollover_amount?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

start_date?

optional start_date?: string | null

Format: date

start_time?

optional start_time?: string | null

Format: date-time

---

null

post.responses.200.content.application/json.department_id?

optional department_id?: string | null

Description

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

post.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

post.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Spend Limit should expire.

post.responses.200.content.application/json.end_time_utc?

optional end_time_utc?: string | null

Format: date-time

Description

The UTC time when the Spend Limit should expire.

post.responses.200.content.application/json.expense_policy_id

expense_policy_id: string

Description

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

post.responses.200.content.application/json.expense_visibility

expense_visibility: "PRIVATE" | "SHARED"

post.responses.200.content.application/json.id

id: string

Description

Unique ID for the Spend Limit.

post.responses.200.content.application/json.legal_entity_id?

optional legal_entity_id?: string | null

Description

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.

post.responses.200.content.application/json.limit_approval_policy_id?

optional limit_approval_policy_id?: string | null

Description

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

post.responses.200.content.application/json.limit_increase_request_policy_id?

optional limit_increase_request_policy_id?: string | null

Description

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

post.responses.200.content.application/json.limit_increase_setting

limit_increase_setting: "DISABLED" | "ENABLED"

post.responses.200.content.application/json.member_user_ids

member_user_ids: string[]

Description

User IDs of the members of the Spend Limit.

post.responses.200.content.application/json.merchant_category_controls?

optional merchant_category_controls?: { allowed_merchant_categories?: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)[] | null; blocked_merchant_categories?: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)[] | null; } | null

post.responses.200.content.application/json.name

name: string

Description

Name for the Spend Limit.

post.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Spend Limit.

post.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

post.responses.200.content.application/json.period_recurrence_type

period_recurrence_type: "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | "ONE_TIME" | "PER_WEEK"

post.responses.200.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

post.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Spend Limit should start counting.

post.responses.200.content.application/json.start_time_utc?

optional start_time_utc?: string | null

Format: date-time

Description

The UTC time when the Spend Limit should start counting.

post.responses.200.content.application/json.status

status: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED"

post.responses.200.content.application/json.transaction_limit?

optional transaction_limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content?

optional content?: undefined

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content?

optional content?: undefined

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content?

optional content?: undefined

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v2/spend_limits/{id}

/v2/spend_limits/{id}: object

Defined in: src/budgets/types.gen.ts:203

delete?

optional delete?: undefined

get

get: object

Get Spend Limit

Description

Retrieves a Spend Limit by ID

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

The Spend Limit that was retrieved

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Spend Limit belongs to.

get.responses.200.content.application/json.authorization_settings?

optional authorization_settings?: { authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; } | null

Union Members

Type Literal

{ authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; }

authorization_type

authorization_type: "HARD" | "SOFT"

base_limit

base_limit: object

base_limit.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

base_limit.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

limit_buffer_percentage?

optional limit_buffer_percentage?: number | null

Format: int32

Description

The percentage of flexible buffer on the limit as a 0-100 integer.

limit_with_increases

limit_with_increases: object

limit_with_increases.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

limit_with_increases.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

rollover_refresh_rate

rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"

---

null

get.responses.200.content.application/json.authorization_visibility

authorization_visibility: "PUBLIC" | "PRIVATE"

get.responses.200.content.application/json.auto_create_limit_cards_setting

auto_create_limit_cards_setting: "DISABLED" | "ALL_MEMBERS"

get.responses.200.content.application/json.auto_transfer_cards_setting

auto_transfer_cards_setting: "DISABLED" | "ENABLED"

get.responses.200.content.application/json.current_period_balance?

optional current_period_balance?: { amount_spent?: { amount: number; currency: … | …; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: … | …; } | null; start_date?: string | null; start_time?: string | null; } | null

Union Members

Type Literal

{ amount_spent?: { amount: number; currency: … | …; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: … | …; } | null; start_date?: string | null; start_time?: string | null; }

amount_spent?

optional amount_spent?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

end_date?

optional end_date?: string | null

Format: date

end_time?

optional end_time?: string | null

Format: date-time

rollover_amount?

optional rollover_amount?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

start_date?

optional start_date?: string | null

Format: date

start_time?

optional start_time?: string | null

Format: date-time

---

null

get.responses.200.content.application/json.department_id?

optional department_id?: string | null

Description

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

get.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

get.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Spend Limit should expire.

get.responses.200.content.application/json.end_time_utc?

optional end_time_utc?: string | null

Format: date-time

Description

The UTC time when the Spend Limit should expire.

get.responses.200.content.application/json.expense_policy_id

expense_policy_id: string

Description

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

get.responses.200.content.application/json.expense_visibility

expense_visibility: "PRIVATE" | "SHARED"

get.responses.200.content.application/json.id

id: string

Description

Unique ID for the Spend Limit.

get.responses.200.content.application/json.legal_entity_id?

optional legal_entity_id?: string | null

Description

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.

get.responses.200.content.application/json.limit_approval_policy_id?

optional limit_approval_policy_id?: string | null

Description

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

get.responses.200.content.application/json.limit_increase_request_policy_id?

optional limit_increase_request_policy_id?: string | null

Description

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

get.responses.200.content.application/json.limit_increase_setting

limit_increase_setting: "DISABLED" | "ENABLED"

get.responses.200.content.application/json.member_user_ids

member_user_ids: string[]

Description

User IDs of the members of the Spend Limit.

get.responses.200.content.application/json.merchant_category_controls?

optional merchant_category_controls?: { allowed_merchant_categories?: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)[] | null; blocked_merchant_categories?: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)[] | null; } | null

get.responses.200.content.application/json.name

name: string

Description

Name for the Spend Limit.

get.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Spend Limit.

get.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

get.responses.200.content.application/json.period_recurrence_type

period_recurrence_type: "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | "ONE_TIME" | "PER_WEEK"

get.responses.200.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

get.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Spend Limit should start counting.

get.responses.200.content.application/json.start_time_utc?

optional start_time_utc?: string | null

Format: date-time

Description

The UTC time when the Spend Limit should start counting.

get.responses.200.content.application/json.status

status: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED"

get.responses.200.content.application/json.transaction_limit?

optional transaction_limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Not Found

get.responses.404.content?

optional content?: undefined

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put

put: object

Update Spend Limit

Description

Updates a Spend Limit

put.parameters

parameters: object

put.parameters.cookie?

optional cookie?: undefined

put.parameters.header

header: object

put.parameters.header.Idempotency-Key

Idempotency-Key: string

put.parameters.path

path: object

put.parameters.path.id

id: string

put.parameters.query?

optional query?: undefined

put.requestBody

requestBody: object

put.requestBody.content

content: object

put.requestBody.content.application/json

application/json: object

put.requestBody.content.application/json.authorization_settings?

optional authorization_settings?: { authorization_type?: "HARD" | "SOFT" | null; base_limit?: { amount: number; currency: string | null; } | null; limit_buffer_percentage?: number | null; rollover_refresh_rate?: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | null; } | null

Union Members

Type Literal

{ authorization_type?: "HARD" | "SOFT" | null; base_limit?: { amount: number; currency: string | null; } | null; limit_buffer_percentage?: number | null; rollover_refresh_rate?: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | null; }

authorization_type?

optional authorization_type?: "HARD" | "SOFT" | null

base_limit?

optional base_limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

limit_buffer_percentage?

optional limit_buffer_percentage?: number | null

Format: int32

Description

The percentage of flexible buffer on the limit as a 0-100 integer.

rollover_refresh_rate?

optional rollover_refresh_rate?: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | null

---

null

put.requestBody.content.application/json.authorization_visibility?

optional authorization_visibility?: "PUBLIC" | "PRIVATE" | null

put.requestBody.content.application/json.auto_create_limit_cards_setting?

optional auto_create_limit_cards_setting?: "DISABLED" | "ALL_MEMBERS" | null

put.requestBody.content.application/json.auto_transfer_cards_setting?

optional auto_transfer_cards_setting?: "DISABLED" | "ENABLED" | null

put.requestBody.content.application/json.department_id?

optional department_id?: string | null

Description

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

put.requestBody.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

put.requestBody.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Spend Limit should expire.

put.requestBody.content.application/json.expense_policy_id?

optional expense_policy_id?: string | null

Description

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

put.requestBody.content.application/json.expense_visibility?

optional expense_visibility?: "PRIVATE" | "SHARED" | null

put.requestBody.content.application/json.legal_entity_id?

optional legal_entity_id?: string | null

Description

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.

put.requestBody.content.application/json.limit_approval_policy_id?

optional limit_approval_policy_id?: string | null

Description

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

put.requestBody.content.application/json.limit_increase_request_policy_id?

optional limit_increase_request_policy_id?: string | null

Description

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

put.requestBody.content.application/json.limit_increase_setting?

optional limit_increase_setting?: "DISABLED" | "ENABLED" | null

put.requestBody.content.application/json.member_user_ids?

optional member_user_ids?: string[] | null

Description

User IDs of the members of the Spend Limit.

put.requestBody.content.application/json.merchant_category_controls?

optional merchant_category_controls?: { allowed_merchant_categories?: ("ADVERTISING_MARKETING" | "GROCERY" | "TELEPHONY" | "OFFICE_SUPPLIES" | "PRIVATE_AIR_TRAVEL" | "CLOTHING" | "CAR_RENTAL" | "VEHICLE_EXPENSES" | "RESTAURANTS" | "GAMBLING" | "FLOWERS" | "ELECTRONICS" | "LEGAL_SERVICES" | "UTILITIES" | "FURNITURE" | "BARS_NIGHTLIFE" | "LAUNDRY" | "EVENT_EXPENSES" | "SHIPPING" | "OTHER_TRAVEL_EXPENSES" | "CHARITY" | "SOFTWARE" | "LODGING" | "FACILITIES_EXPENSES" | "SERVERS" | "CONFERENCES" | "FOOD_DELIVERY" | "RENT" | "AIRLINE_EXPENSES" | "OTHER_BUSINESS_EXPENSES" | "BANK_FINANCIAL_FEES" | "BOOKS_NEWSPAPERS" | "CONSULTANT_CONTRACTOR" | "CORPORATE_INSURANCE" | "DIGITAL_GOODS" | "LICENSES_TAXES" | "GAS_FUEL" | "GENERAL_MERCHANDISE" | "MEDICAL" | "MEMBERSHIPS_CLUBS" | "PARKING_EXPENSES" | "POLITICAL_DONATIONS" | "PUBLIC_TRANSPORTATION" | "RECURRING_SOFTWARE_SAAS" | "RIDESHARE_TAXI" | "TOLL_BRIDGE_FEES" | "TRAINING_EDUCATION" | "TRAVEL")[] | null; blocked_merchant_categories?: ("ADVERTISING_MARKETING" | "GROCERY" | "TELEPHONY" | "OFFICE_SUPPLIES" | "PRIVATE_AIR_TRAVEL" | "CLOTHING" | "CAR_RENTAL" | "VEHICLE_EXPENSES" | "RESTAURANTS" | "GAMBLING" | "FLOWERS" | "ELECTRONICS" | "LEGAL_SERVICES" | "UTILITIES" | "FURNITURE" | "BARS_NIGHTLIFE" | "LAUNDRY" | "EVENT_EXPENSES" | "SHIPPING" | "OTHER_TRAVEL_EXPENSES" | "CHARITY" | "SOFTWARE" | "LODGING" | "FACILITIES_EXPENSES" | "SERVERS" | "CONFERENCES" | "FOOD_DELIVERY" | "RENT" | "AIRLINE_EXPENSES" | "OTHER_BUSINESS_EXPENSES" | "BANK_FINANCIAL_FEES" | "BOOKS_NEWSPAPERS" | "CONSULTANT_CONTRACTOR" | "CORPORATE_INSURANCE" | "DIGITAL_GOODS" | "LICENSES_TAXES" | "GAS_FUEL" | "GENERAL_MERCHANDISE" | "MEDICAL" | "MEMBERSHIPS_CLUBS" | "PARKING_EXPENSES" | "POLITICAL_DONATIONS" | "PUBLIC_TRANSPORTATION" | "RECURRING_SOFTWARE_SAAS" | "RIDESHARE_TAXI" | "TOLL_BRIDGE_FEES" | "TRAINING_EDUCATION" | "TRAVEL")[] | null; } | null

put.requestBody.content.application/json.name?

optional name?: string | null

Description

Name for the Spend Limit.

put.requestBody.content.application/json.owner_user_ids?

optional owner_user_ids?: string[] | null

Description

User IDs of the owners of the Spend Limit.

put.requestBody.content.application/json.period_recurrence_type?

optional period_recurrence_type?: "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | "ONE_TIME" | "PER_WEEK" | null

put.requestBody.content.application/json.set_end_date_null?

optional set_end_date_null?: boolean | null

Description

Set the date when the Spend Limit should expire to null.

put.requestBody.content.application/json.set_start_date_null?

optional set_start_date_null?: boolean | null

Description

Set the date when the Spend Limit should start counting to null.

put.requestBody.content.application/json.set_transaction_limit_null?

optional set_transaction_limit_null?: boolean | null

Description

Set the transaction limit that this Spend Limit will enforce to null.

put.requestBody.content.application/json.spend_type?

optional spend_type?: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED" | null

put.requestBody.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Spend Limit should start counting.

put.requestBody.content.application/json.status?

optional status?: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED" | null

put.requestBody.content.application/json.transaction_limit?

optional transaction_limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

put.responses

responses: object

put.responses.200

200: object

Description

The Spend Limit that was updated

put.responses.200.content

content: object

put.responses.200.content.application/json

application/json: object

put.responses.200.content.application/json.account_id

account_id: string

Description

The Brex account this Spend Limit belongs to.

put.responses.200.content.application/json.authorization_settings?

optional authorization_settings?: { authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; } | null

Union Members

Type Literal

{ authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; }

authorization_type

authorization_type: "HARD" | "SOFT"

base_limit

base_limit: object

base_limit.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

base_limit.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

limit_buffer_percentage?

optional limit_buffer_percentage?: number | null

Format: int32

Description

The percentage of flexible buffer on the limit as a 0-100 integer.

limit_with_increases

limit_with_increases: object

limit_with_increases.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

limit_with_increases.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

rollover_refresh_rate

rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"

---

null

put.responses.200.content.application/json.authorization_visibility

authorization_visibility: "PUBLIC" | "PRIVATE"

put.responses.200.content.application/json.auto_create_limit_cards_setting

auto_create_limit_cards_setting: "DISABLED" | "ALL_MEMBERS"

put.responses.200.content.application/json.auto_transfer_cards_setting

auto_transfer_cards_setting: "DISABLED" | "ENABLED"

put.responses.200.content.application/json.current_period_balance?

optional current_period_balance?: { amount_spent?: { amount: number; currency: … | …; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: … | …; } | null; start_date?: string | null; start_time?: string | null; } | null

Union Members

Type Literal

{ amount_spent?: { amount: number; currency: … | …; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: … | …; } | null; start_date?: string | null; start_time?: string | null; }

amount_spent?

optional amount_spent?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

end_date?

optional end_date?: string | null

Format: date

end_time?

optional end_time?: string | null

Format: date-time

rollover_amount?

optional rollover_amount?: { amount: number; currency: … | …; } | null

Union Members

Type Literal

{ amount: number; currency: … | …; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: … | …

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

start_date?

optional start_date?: string | null

Format: date

start_time?

optional start_time?: string | null

Format: date-time

---

null

put.responses.200.content.application/json.department_id?

optional department_id?: string | null

Description

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

put.responses.200.content.application/json.description?

optional description?: string | null

Description

Description of what the Spend Limit is used for.

put.responses.200.content.application/json.end_date?

optional end_date?: string | null

Format: date

Description

The date when the Spend Limit should expire.

put.responses.200.content.application/json.end_time_utc?

optional end_time_utc?: string | null

Format: date-time

Description

The UTC time when the Spend Limit should expire.

put.responses.200.content.application/json.expense_policy_id

expense_policy_id: string

Description

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

put.responses.200.content.application/json.expense_visibility

expense_visibility: "PRIVATE" | "SHARED"

put.responses.200.content.application/json.id

id: string

Description

Unique ID for the Spend Limit.

put.responses.200.content.application/json.legal_entity_id?

optional legal_entity_id?: string | null

Description

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.

put.responses.200.content.application/json.limit_approval_policy_id?

optional limit_approval_policy_id?: string | null

Description

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

put.responses.200.content.application/json.limit_increase_request_policy_id?

optional limit_increase_request_policy_id?: string | null

Description

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

put.responses.200.content.application/json.limit_increase_setting

limit_increase_setting: "DISABLED" | "ENABLED"

put.responses.200.content.application/json.member_user_ids

member_user_ids: string[]

Description

User IDs of the members of the Spend Limit.

put.responses.200.content.application/json.merchant_category_controls?

optional merchant_category_controls?: { allowed_merchant_categories?: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)[] | null; blocked_merchant_categories?: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)[] | null; } | null

put.responses.200.content.application/json.name

name: string

Description

Name for the Spend Limit.

put.responses.200.content.application/json.owner_user_ids

owner_user_ids: string[]

Description

User IDs of the owners of the Spend Limit.

put.responses.200.content.application/json.parent_budget_id?

optional parent_budget_id?: string | null

Description

ID of parent Budget.

put.responses.200.content.application/json.period_recurrence_type

period_recurrence_type: "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | "ONE_TIME" | "PER_WEEK"

put.responses.200.content.application/json.spend_type

spend_type: "BUDGET_PROVISIONED_CARDS_ONLY" | "NON_BUDGET_PROVISIONED_CARDS_ALLOWED"

put.responses.200.content.application/json.start_date?

optional start_date?: string | null

Format: date

Description

The date when the Spend Limit should start counting.

put.responses.200.content.application/json.start_time_utc?

optional start_time_utc?: string | null

Format: date-time

Description

The UTC time when the Spend Limit should start counting.

put.responses.200.content.application/json.status

status: "ACTIVE" | "ARCHIVED" | "DELETED" | "EXPIRED"

put.responses.200.content.application/json.transaction_limit?

optional transaction_limit?: { amount: number; currency: string | null; } | null

Union Members

Type Literal

{ amount: number; currency: string | null; }

amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

700

currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

---

null

put.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.400

400: object

Description

Bad request

put.responses.400.content?

optional content?: undefined

put.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.401

401: object

Description

Unauthorized

put.responses.401.content?

optional content?: undefined

put.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.403

403: object

Description

Forbidden

put.responses.403.content?

optional content?: undefined

put.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.404

404: object

Description

Not Found

put.responses.404.content?

optional content?: undefined

put.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

trace?

optional trace?: undefined

---

/v2/spend_limits/{id}/archive

/v2/spend_limits/{id}/archive: object

Defined in: src/budgets/types.gen.ts:227

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Archive a Spend Limit

Description

Archives a Spend Limit, making it unusable for future expenses and removing it from the UI

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path

path: object

post.parameters.path.id

id: string

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

The Spend Limit that was archived

post.responses.200.content?

optional content?: undefined

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content?

optional content?: undefined

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content?

optional content?: undefined

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content?

optional content?: undefined

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.404

404: object

Description

Not Found

post.responses.404.content?

optional content?: undefined

post.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined