TeamComponents
Defined in: src/team/types.gen.ts:449
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/team/types.gen.ts:890
parameters
Section titled “parameters”parameters:
never
Defined in: src/team/types.gen.ts:888
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/team/types.gen.ts:891
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/team/types.gen.ts:889
responses
Section titled “responses”responses:
never
Defined in: src/team/types.gen.ts:887
schemas
Section titled “schemas”schemas:
object
Defined in: src/team/types.gen.ts:450
AccountType
Section titled “AccountType”AccountType:
"BREX_CLASSIC"|"BREX_EMPOWER"
Address
Section titled “Address”Address:
object
Description
Section titled “Description”Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).
Address.city?
Section titled “Address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
Address.country?
Section titled “Address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
Address.line1?
Section titled “Address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
Address.line2?
Section titled “Address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
Address.phone_number?
Section titled “Address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
Address.postal_code?
Section titled “Address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
Address.state?
Section titled “Address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
Card:
object
Description
Section titled “Description”Only cards with limit_type = CARD have spend_controls
Card.billing_address
Section titled “Card.billing_address”billing_address:
object
Card.billing_address.city?
Section titled “Card.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
Card.billing_address.country?
Section titled “Card.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
Card.billing_address.line1?
Section titled “Card.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
Card.billing_address.line2?
Section titled “Card.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
Card.billing_address.phone_number?
Section titled “Card.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
Card.billing_address.postal_code?
Section titled “Card.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
Card.billing_address.state?
Section titled “Card.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
Card.budget_id?
Section titled “Card.budget_id?”
optionalbudget_id?:string|null
Card.card_name
Section titled “Card.card_name”card_name:
string
Card.card_type?
Section titled “Card.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
Card.expiration_date
Section titled “Card.expiration_date”expiration_date:
object
Card.expiration_date.month
Section titled “Card.expiration_date.month”month:
number
Format: int32
Card.expiration_date.year
Section titled “Card.expiration_date.year”year:
number
Format: int32
Card.has_been_transferred?
Section titled “Card.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
Card.id
Section titled “Card.id”id:
string
Card.last_four
Section titled “Card.last_four”last_four:
string
Card.limit_type
Section titled “Card.limit_type”limit_type:
"CARD"|"USER"
Card.mailing_address?
Section titled “Card.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
Card.metadata?
Section titled “Card.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
Card.owner
Section titled “Card.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Card.spend_controls?
Section titled “Card.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency:string|null; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency:string|null; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: string | null; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: string | null; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
Card.status?
Section titled “Card.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
CardAttributePreferences
Section titled “CardAttributePreferences”CardAttributePreferences:
object
CardAttributePreferences.three_domain_secure_enabled_preference?
Section titled “CardAttributePreferences.three_domain_secure_enabled_preference?”
optionalthree_domain_secure_enabled_preference?:"THREE_DOMAIN_SECURE_ENABLED"|"THREE_DOMAIN_SECURE_DISABLED"|null
CardExpiration
Section titled “CardExpiration”CardExpiration:
object
Description
Section titled “Description”Card expiration year and month. Cards expire on the last day of the expiration month.
The expiration date is in UTC for cards starting with 555671, 428803 and 485932.And the expiration date is in PST for cards starting with 511572.CardExpiration.month
Section titled “CardExpiration.month”month:
number
Format: int32
CardExpiration.year
Section titled “CardExpiration.year”year:
number
Format: int32
CardNumberResponse
Section titled “CardNumberResponse”CardNumberResponse:
object
Description
Section titled “Description”Card number, CVV, and expiration date of a card.
CardNumberResponse.cvv
Section titled “CardNumberResponse.cvv”cvv:
string
CardNumberResponse.expiration_date
Section titled “CardNumberResponse.expiration_date”expiration_date:
object
CardNumberResponse.expiration_date.month
Section titled “CardNumberResponse.expiration_date.month”month:
number
Format: int32
CardNumberResponse.expiration_date.year
Section titled “CardNumberResponse.expiration_date.year”year:
number
Format: int32
CardNumberResponse.holder_name
Section titled “CardNumberResponse.holder_name”holder_name:
string
CardNumberResponse.id
Section titled “CardNumberResponse.id”id:
string
CardNumberResponse.number
Section titled “CardNumberResponse.number”number:
string
CardOwner
Section titled “CardOwner”CardOwner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CardStatus
Section titled “CardStatus”CardStatus:
"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"
CardType
Section titled “CardType”CardType:
"VIRTUAL"|"PHYSICAL"
ChangeCardReason
Section titled “ChangeCardReason”ChangeCardReason:
"OTHER"|"CARD_DAMAGED"|"CARD_LOST"|"CARD_NOT_RECEIVED"|"DO_NOT_NEED_PHYSICAL_CARD"|"DO_NOT_NEED_VIRTUAL_CARD"|"FRAUD"
Description
Section titled “Description”Reason for card termination.
CompanyResponse
Section titled “CompanyResponse”CompanyResponse:
object
CompanyResponse.accountType
Section titled “CompanyResponse.accountType”accountType:
"BREX_CLASSIC"|"BREX_EMPOWER"
CompanyResponse.id
Section titled “CompanyResponse.id”id:
string
CompanyResponse.legal_name
Section titled “CompanyResponse.legal_name”legal_name:
string
CompanyResponse.mailing_address
Section titled “CompanyResponse.mailing_address”mailing_address:
object
CompanyResponse.mailing_address.city?
Section titled “CompanyResponse.mailing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
CompanyResponse.mailing_address.country?
Section titled “CompanyResponse.mailing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
CompanyResponse.mailing_address.line1?
Section titled “CompanyResponse.mailing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
CompanyResponse.mailing_address.line2?
Section titled “CompanyResponse.mailing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
CompanyResponse.mailing_address.phone_number?
Section titled “CompanyResponse.mailing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
CompanyResponse.mailing_address.postal_code?
Section titled “CompanyResponse.mailing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
CompanyResponse.mailing_address.state?
Section titled “CompanyResponse.mailing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
CreateCardRequest
Section titled “CreateCardRequest”CreateCardRequest:
object
Description
Section titled “Description”The spend_controls field is required when limit_type = CARD.
The shipping_address field is required for physical cards, and the first 2 lines of the address must be under 60 characters long.
CreateCardRequest.card_attribute_preferences?
Section titled “CreateCardRequest.card_attribute_preferences?”
optionalcard_attribute_preferences?: {three_domain_secure_enabled_preference?:"THREE_DOMAIN_SECURE_ENABLED"|"THREE_DOMAIN_SECURE_DISABLED"|null; } |null
CreateCardRequest.card_name
Section titled “CreateCardRequest.card_name”card_name:
string
CreateCardRequest.card_type
Section titled “CreateCardRequest.card_type”card_type:
"VIRTUAL"|"PHYSICAL"
CreateCardRequest.limit_type
Section titled “CreateCardRequest.limit_type”limit_type:
"CARD"|"USER"
CreateCardRequest.mailing_address?
Section titled “CreateCardRequest.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
CreateCardRequest.metadata?
Section titled “CreateCardRequest.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
CreateCardRequest.owner
Section titled “CreateCardRequest.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CreateCardRequest.spend_controls?
Section titled “CreateCardRequest.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;parent_budget_id?:string|null;policy_id?:string|null;reason?:string|null;spend_duration:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME";spend_limit: {amount:number;currency:string|null; }; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; parent_budget_id?: string | null; policy_id?: string | null; reason?: string | null; spend_duration: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"; spend_limit: { amount: number; currency: string | null; }; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
parent_budget_id?
Section titled “parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”If using the Empower platform, a new budget will be created for this card. You can specify a parent_budget that your new
budget will be nested under. If parent_budget_id is null, we will nest the new budget under the top-level account budget.
policy_id?
Section titled “policy_id?”
optionalpolicy_id?:string|null
reason?
Section titled “reason?”
optionalreason?:string|null
spend_duration
Section titled “spend_duration”spend_duration:
"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
spend_limit
Section titled “spend_limit”spend_limit:
object
spend_limit.amount
Section titled “spend_limit.amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700spend_limit.currency
Section titled “spend_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
CreateDepartmentRequest
Section titled “CreateDepartmentRequest”CreateDepartmentRequest:
object
CreateDepartmentRequest.description?
Section titled “CreateDepartmentRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the department
CreateDepartmentRequest.name
Section titled “CreateDepartmentRequest.name”name:
string
Description
Section titled “Description”Name of the department
CreateLocationRequest
Section titled “CreateLocationRequest”CreateLocationRequest:
object
CreateLocationRequest.description?
Section titled “CreateLocationRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the location
CreateLocationRequest.name
Section titled “CreateLocationRequest.name”name:
string
Description
Section titled “Description”Name of the location
CreateTitleRequest
Section titled “CreateTitleRequest”CreateTitleRequest:
object
CreateTitleRequest.name
Section titled “CreateTitleRequest.name”name:
string
Description
Section titled “Description”Name of the title
CreateUserRequest
Section titled “CreateUserRequest”CreateUserRequest:
object
CreateUserRequest.department_id?
Section titled “CreateUserRequest.department_id?”
optionaldepartment_id?:string|null
CreateUserRequest.email
Section titled “CreateUserRequest.email”email:
string
Format: email
CreateUserRequest.first_name
Section titled “CreateUserRequest.first_name”first_name:
string
CreateUserRequest.last_name
Section titled “CreateUserRequest.last_name”last_name:
string
CreateUserRequest.location_id?
Section titled “CreateUserRequest.location_id?”
optionallocation_id?:string|null
CreateUserRequest.manager_id?
Section titled “CreateUserRequest.manager_id?”
optionalmanager_id?:string|null
CreateUserRequest.metadata?
Section titled “CreateUserRequest.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
CreateUserRequest.title_id?
Section titled “CreateUserRequest.title_id?”
optionaltitle_id?:string|null
DepartmentResponse
Section titled “DepartmentResponse”DepartmentResponse:
object
DepartmentResponse.description?
Section titled “DepartmentResponse.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the department
DepartmentResponse.id
Section titled “DepartmentResponse.id”id:
string
DepartmentResponse.name
Section titled “DepartmentResponse.name”name:
string
Description
Section titled “Description”Name of the department
LegalEntity
Section titled “LegalEntity”LegalEntity:
object
Legal Entity
Description
Section titled “Description”A Brex legal entity.
LegalEntity.billingAddress
Section titled “LegalEntity.billingAddress”billingAddress:
object
LegalEntity.billingAddress.city?
Section titled “LegalEntity.billingAddress.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
LegalEntity.billingAddress.country?
Section titled “LegalEntity.billingAddress.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
LegalEntity.billingAddress.line1?
Section titled “LegalEntity.billingAddress.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
LegalEntity.billingAddress.line2?
Section titled “LegalEntity.billingAddress.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
LegalEntity.billingAddress.phone_number?
Section titled “LegalEntity.billingAddress.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
LegalEntity.billingAddress.postal_code?
Section titled “LegalEntity.billingAddress.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
LegalEntity.billingAddress.state?
Section titled “LegalEntity.billingAddress.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
LegalEntity.createdAt
Section titled “LegalEntity.createdAt”createdAt:
string
Format: date-time
Description
Section titled “Description”Timestamp, in UTC, when this legal entity was created.
LegalEntity.displayName
Section titled “LegalEntity.displayName”displayName:
string
Description
Section titled “Description”The display name of this legal entity.
LegalEntity.id
Section titled “LegalEntity.id”id:
string
Description
Section titled “Description”The ID of this legal entity.
LegalEntity.isDefault?
Section titled “LegalEntity.isDefault?”
optionalisDefault?:boolean
Description
Section titled “Description”Whether this is the default entity of the account.
LegalEntity.status
Section titled “LegalEntity.status”status:
"UNSUBMITTED"|"UNVERIFIED"|"IN_PROGRESS"|"VERIFIED"|"REJECTED"
LegalEntityStatus
Section titled “LegalEntityStatus”LegalEntityStatus:
"UNSUBMITTED"|"UNVERIFIED"|"IN_PROGRESS"|"VERIFIED"|"REJECTED"
Description
Section titled “Description”The possible statuses for an entity’s verification in Brex.
LimitType
Section titled “LimitType”LimitType:
"CARD"|"USER"
Description
Section titled “Description”limit_type = CARD for vendor cards. Vendor cards must have a card_type of VIRTUAL
and do not rely on the user specific limit.
For corporate cards, `limit_type = USER`.
Learn more about different card types [here](https://support.brex.com/what-are-the-different-types-of-cards-i-can-get/).LocationResponse
Section titled “LocationResponse”LocationResponse:
object
LocationResponse.description?
Section titled “LocationResponse.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the location
LocationResponse.id
Section titled “LocationResponse.id”id:
string
LocationResponse.name
Section titled “LocationResponse.name”name:
string
Description
Section titled “Description”Name of the location
LockCardRequest
Section titled “LockCardRequest”LockCardRequest:
object
Description
Section titled “Description”Parameters for locking a card.
LockCardRequest.description?
Section titled “LockCardRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description for locking a card
LockCardRequest.reason
Section titled “LockCardRequest.reason”reason:
"OTHER"|"CARD_DAMAGED"|"CARD_LOST"|"CARD_NOT_RECEIVED"|"DO_NOT_NEED_PHYSICAL_CARD"|"DO_NOT_NEED_VIRTUAL_CARD"|"FRAUD"
LockedMerchantDetails
Section titled “LockedMerchantDetails”LockedMerchantDetails:
object
Description
Section titled “Description”Merchant details used for restricting or blocking transactions.
LockedMerchantDetails.name
Section titled “LockedMerchantDetails.name”name:
string
Description
Section titled “Description”The name of the merchant.
Example
Section titled “Example”GithubMoney:
object
Description
Section titled “Description”Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Money.amount
Section titled “Money.amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700Money.currency
Section titled “Money.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDOwnerType
Section titled “OwnerType”OwnerType:
"USER"
Page_Card_
Section titled “Page_Card_”Page_Card_:
object
Page_Card_.items
Section titled “Page_Card_.items”items:
object[]
Page_Card_.next_cursor?
Section titled “Page_Card_.next_cursor?”
optionalnext_cursor?:string|null
Page_DepartmentResponse_
Section titled “Page_DepartmentResponse_”Page_DepartmentResponse_:
object
Page_DepartmentResponse_.items
Section titled “Page_DepartmentResponse_.items”items:
object[]
Page_DepartmentResponse_.next_cursor?
Section titled “Page_DepartmentResponse_.next_cursor?”
optionalnext_cursor?:string|null
Page_LegalEntity_
Section titled “Page_LegalEntity_”Page_LegalEntity_:
object
Page_LegalEntity_.items
Section titled “Page_LegalEntity_.items”items:
object[]
Page_LegalEntity_.next_cursor?
Section titled “Page_LegalEntity_.next_cursor?”
optionalnext_cursor?:string|null
Page_LocationResponse_
Section titled “Page_LocationResponse_”Page_LocationResponse_:
object
Page_LocationResponse_.items
Section titled “Page_LocationResponse_.items”items:
object[]
Page_LocationResponse_.next_cursor?
Section titled “Page_LocationResponse_.next_cursor?”
optionalnext_cursor?:string|null
Page_TitleResponse_
Section titled “Page_TitleResponse_”Page_TitleResponse_:
object
Page_TitleResponse_.items
Section titled “Page_TitleResponse_.items”items:
object[]
Page_TitleResponse_.next_cursor?
Section titled “Page_TitleResponse_.next_cursor?”
optionalnext_cursor?:string|null
Page_UserResponse_
Section titled “Page_UserResponse_”Page_UserResponse_:
object
Page_UserResponse_.items
Section titled “Page_UserResponse_.items”items:
object[]
Page_UserResponse_.next_cursor?
Section titled “Page_UserResponse_.next_cursor?”
optionalnext_cursor?:string|null
SecureEmailForCardDetailsRequest
Section titled “SecureEmailForCardDetailsRequest”SecureEmailForCardDetailsRequest:
object
SecureEmailForCardDetailsRequest.expiry_days?
Section titled “SecureEmailForCardDetailsRequest.expiry_days?”
optionalexpiry_days?:number|null
Format: int32
Description
Section titled “Description”Link expiry in number of days. Defaults to 30
SecureEmailForCardDetailsRequest.message?
Section titled “SecureEmailForCardDetailsRequest.message?”
optionalmessage?:string|null
Description
Section titled “Description”Message to send with the card details
SecureEmailForCardDetailsRequest.recipient_email
Section titled “SecureEmailForCardDetailsRequest.recipient_email”recipient_email:
string
Description
Section titled “Description”Email address to send card details to
SecureEmailForCardDetailsRequest.sender_name
Section titled “SecureEmailForCardDetailsRequest.sender_name”sender_name:
string
Description
Section titled “Description”Sender name. Shows up in the subject of the email
SetUserLimitRequest
Section titled “SetUserLimitRequest”SetUserLimitRequest:
object
Description
Section titled “Description”Request that sets the monthly user limit.
SetUserLimitRequest.monthly_limit?
Section titled “SetUserLimitRequest.monthly_limit?”
optionalmonthly_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
SpendControl
Section titled “SpendControl”SpendControl:
object
SpendControl.allowed_merchant_details?
Section titled “SpendControl.allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]SpendControl.blocked_merchant_details?
Section titled “SpendControl.blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]SpendControl.lock_after_date?
Section titled “SpendControl.lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
SpendControl.reason?
Section titled “SpendControl.reason?”
optionalreason?:string|null
SpendControl.spend_available?
Section titled “SpendControl.spend_available?”
optionalspend_available?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
SpendControl.spend_duration?
Section titled “SpendControl.spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
SpendControl.spend_limit?
Section titled “SpendControl.spend_limit?”
optionalspend_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
SpendControlRequest
Section titled “SpendControlRequest”SpendControlRequest:
object
Description
Section titled “Description”When limit_type = CARD, spend_controls must be set. When limit type = USER, spend_controls must be null.
SpendControlRequest.allowed_merchant_details?
Section titled “SpendControlRequest.allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]SpendControlRequest.blocked_merchant_details?
Section titled “SpendControlRequest.blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]SpendControlRequest.lock_after_date?
Section titled “SpendControlRequest.lock_after_date?”
optionallock_after_date?:string|null
Format: date
SpendControlRequest.parent_budget_id?
Section titled “SpendControlRequest.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”If using the Empower platform, a new budget will be created for this card. You can specify a parent_budget that your new
budget will be nested under. If parent_budget_id is null, we will nest the new budget under the top-level account budget.
SpendControlRequest.policy_id?
Section titled “SpendControlRequest.policy_id?”
optionalpolicy_id?:string|null
SpendControlRequest.reason?
Section titled “SpendControlRequest.reason?”
optionalreason?:string|null
SpendControlRequest.spend_duration
Section titled “SpendControlRequest.spend_duration”spend_duration:
"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
SpendControlRequest.spend_limit
Section titled “SpendControlRequest.spend_limit”spend_limit:
object
SpendControlRequest.spend_limit.amount
Section titled “SpendControlRequest.spend_limit.amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700SpendControlRequest.spend_limit.currency
Section titled “SpendControlRequest.spend_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDSpendControlUpdateRequest
Section titled “SpendControlUpdateRequest”SpendControlUpdateRequest:
object
SpendControlUpdateRequest.allowed_merchant_details?
Section titled “SpendControlUpdateRequest.allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]SpendControlUpdateRequest.blocked_merchant_details?
Section titled “SpendControlUpdateRequest.blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]SpendControlUpdateRequest.lock_after_date?
Section titled “SpendControlUpdateRequest.lock_after_date?”
optionallock_after_date?:string|null
Format: date
SpendControlUpdateRequest.reason?
Section titled “SpendControlUpdateRequest.reason?”
optionalreason?:string|null
SpendControlUpdateRequest.spend_duration?
Section titled “SpendControlUpdateRequest.spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
SpendControlUpdateRequest.spend_limit?
Section titled “SpendControlUpdateRequest.spend_limit?”
optionalspend_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
SpendDuration
Section titled “SpendDuration”SpendDuration:
"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
Description
Section titled “Description”Spend limit refresh frequency - MONTHLY: The spend limit refreshes every month - QUARTERLY: The spend limit refreshes every quarter - YEARLY: The spend limit refreshes every year - ONE_TIME: The limit does not refresh
TerminateCardRequest
Section titled “TerminateCardRequest”TerminateCardRequest:
object
Description
Section titled “Description”Parameters for terminating a card.
TerminateCardRequest.description?
Section titled “TerminateCardRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description for terminating a card
TerminateCardRequest.reason
Section titled “TerminateCardRequest.reason”reason:
"OTHER"|"CARD_DAMAGED"|"CARD_LOST"|"CARD_NOT_RECEIVED"|"DO_NOT_NEED_PHYSICAL_CARD"|"DO_NOT_NEED_VIRTUAL_CARD"|"FRAUD"
ThreeDomainSecureEnabledPreference
Section titled “ThreeDomainSecureEnabledPreference”ThreeDomainSecureEnabledPreference:
"THREE_DOMAIN_SECURE_ENABLED"|"THREE_DOMAIN_SECURE_DISABLED"
Description
Section titled “Description”Whether to enable 3-D secure protocol on this card.
TitleResponse
Section titled “TitleResponse”TitleResponse:
object
TitleResponse.id
Section titled “TitleResponse.id”id:
string
TitleResponse.name
Section titled “TitleResponse.name”name:
string
Description
Section titled “Description”Name of the title
UpdateCardRequest
Section titled “UpdateCardRequest”UpdateCardRequest:
object
UpdateCardRequest.metadata?
Section titled “UpdateCardRequest.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
UpdateCardRequest.spend_controls?
Section titled “UpdateCardRequest.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency:string|null; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: string | null; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
reason?
Section titled “reason?”
optionalreason?:string|null
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
UpdateUserRequest
Section titled “UpdateUserRequest”UpdateUserRequest:
object
UpdateUserRequest.department_id?
Section titled “UpdateUserRequest.department_id?”
optionaldepartment_id?:string|null
UpdateUserRequest.location_id?
Section titled “UpdateUserRequest.location_id?”
optionallocation_id?:string|null
UpdateUserRequest.manager_id?
Section titled “UpdateUserRequest.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
UpdateUserRequest.metadata?
Section titled “UpdateUserRequest.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
UpdateUserRequest.status?
Section titled “UpdateUserRequest.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|null
UpdateUserRequest.title_id?
Section titled “UpdateUserRequest.title_id?”
optionaltitle_id?:string|null
UpdateUserStatus
Section titled “UpdateUserStatus”UpdateUserStatus:
"ACTIVE"|"DISABLED"
Description
Section titled “Description”Acceptable user status for update. To suspend a user, set status to ‘disabled’. To unsuspend a user, set status to ‘active’.
UserLimitResponse
Section titled “UserLimitResponse”UserLimitResponse:
object
UserLimitResponse.monthly_available?
Section titled “UserLimitResponse.monthly_available?”
optionalmonthly_available?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
UserLimitResponse.monthly_limit?
Section titled “UserLimitResponse.monthly_limit?”
optionalmonthly_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
UserOwner
Section titled “UserOwner”UserOwner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
UserResponse
Section titled “UserResponse”UserResponse:
object
UserResponse.department_id?
Section titled “UserResponse.department_id?”
optionaldepartment_id?:string|null
UserResponse.email
Section titled “UserResponse.email”email:
string
Description
Section titled “Description”Email address of the user
UserResponse.first_name
Section titled “UserResponse.first_name”first_name:
string
Description
Section titled “Description”First name of the user
UserResponse.id
Section titled “UserResponse.id”id:
string
UserResponse.last_name
Section titled “UserResponse.last_name”last_name:
string
Description
Section titled “Description”Last name of the user
UserResponse.location_id?
Section titled “UserResponse.location_id?”
optionallocation_id?:string|null
UserResponse.manager_id?
Section titled “UserResponse.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
UserResponse.metadata?
Section titled “UserResponse.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
UserResponse.remote_display_id?
Section titled “UserResponse.remote_display_id?”
optionalremote_display_id?:string|null
Description
Section titled “Description”Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz
UserResponse.status?
Section titled “UserResponse.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"|"CLOSED"|null
UserResponse.title_id?
Section titled “UserResponse.title_id?”
optionaltitle_id?:string|null
UserStatus
Section titled “UserStatus”UserStatus:
"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"|"CLOSED"
Description
Section titled “Description”Status of the user