--- title: TeamPaths editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/team/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L2) ## Properties ### /v2/cards > **/v2/cards**: `object` Defined in: [src/team/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L3) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` List cards ##### Description Lists all cards by a `user_id`. Only cards with `limit_type = CARD` have `spend_controls` ##### 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.user\_id? > `optional` **user\_id?**: `string` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description listCardsByUserId 200 response ##### 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` #### 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 card ##### Description Creates a new card. The `spend_controls` field is required when `limit_type` = `CARD`. The `mailing_address` field is required for physical cards and is the shipping address used to send the card; it is not the same as the billing and mailing address used for online purchases. The first 2 lines of this address must be under 60 characters long. Each user can only have up to 10 active physical cards. For Empower accounts, this endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support. ##### 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.card\_attribute\_preferences? > `optional` **card\_attribute\_preferences?**: \{ `three_domain_secure_enabled_preference?`: `"THREE_DOMAIN_SECURE_ENABLED"` \| `"THREE_DOMAIN_SECURE_DISABLED"` \| `null`; \} \| `null` ##### post.requestBody.content.application/json.card\_name > **card\_name**: `string` ##### post.requestBody.content.application/json.card\_type > **card\_type**: `"VIRTUAL"` \| `"PHYSICAL"` ##### post.requestBody.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### post.requestBody.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.requestBody.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### post.requestBody.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### post.requestBody.content.application/json.spend\_controls? > `optional` **spend\_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 ###### 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? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### 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? > `optional` **policy\_id?**: `string` \| `null` ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_duration > **spend\_duration**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ###### spend\_limit > **spend\_limit**: `object` ###### spend\_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 ```ts 700 ``` ###### spend\_limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createCard 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### post.responses.200.content.application/json.card\_name > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### post.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? > `optional` **has\_been\_transferred?**: `boolean` ###### 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. ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.last\_four > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### post.responses.200.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### post.responses.200.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? > `optional` **spend\_controls?**: \{ `allowed_merchant_details?`: `object`[] \| `null`; `blocked_merchant_details?`: `object`[] \| `null`; `lock_after_date?`: `string` \| `null`; `reason?`: `string` \| `null`; `spend_available?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} \| `null` ###### Union Members ###### 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`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} ###### allowed\_merchant\_details? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_available? > `optional` **spend\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_limit?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/cards/\{id\} > **/v2/cards/\{id\}**: `object` Defined in: [src/team/types.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L33) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get card ##### Description Retrieves a card by ID. Only cards with `limit_type = CARD` have `spend_controls` ##### 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 getCardById 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.billing\_address > **billing\_address**: `object` ##### get.responses.200.content.application/json.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### get.responses.200.content.application/json.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### get.responses.200.content.application/json.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### get.responses.200.content.application/json.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### get.responses.200.content.application/json.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### get.responses.200.content.application/json.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### get.responses.200.content.application/json.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### get.responses.200.content.application/json.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### get.responses.200.content.application/json.card\_name > **card\_name**: `string` ##### get.responses.200.content.application/json.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### get.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### get.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### get.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### get.responses.200.content.application/json.has\_been\_transferred? > `optional` **has\_been\_transferred?**: `boolean` ###### 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. ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.last\_four > **last\_four**: `string` ##### get.responses.200.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### get.responses.200.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### get.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### get.responses.200.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### get.responses.200.content.application/json.spend\_controls? > `optional` **spend\_controls?**: \{ `allowed_merchant_details?`: `object`[] \| `null`; `blocked_merchant_details?`: `object`[] \| `null`; `lock_after_date?`: `string` \| `null`; `reason?`: `string` \| `null`; `spend_available?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} \| `null` ###### Union Members ###### 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`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} ###### allowed\_merchant\_details? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_available? > `optional` **spend\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_limit?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### get.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` ##### get.responses.200.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 card ##### Description Update an existing vendor card ##### put.parameters > **parameters**: `object` ##### put.parameters.cookie? > `optional` **cookie?**: `undefined` ##### put.parameters.header? > `optional` **header?**: `object` ##### put.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### put.requestBody.content.application/json.spend\_controls? > `optional` **spend\_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 ###### 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? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### put.responses > **responses**: `object` ##### put.responses.200 > **200**: `object` ###### Description updateCard 200 response ##### put.responses.200.content > **content**: `object` ##### put.responses.200.content.application/json > **application/json**: `object` ##### put.responses.200.content.application/json.billing\_address > **billing\_address**: `object` ##### put.responses.200.content.application/json.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### put.responses.200.content.application/json.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### put.responses.200.content.application/json.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### put.responses.200.content.application/json.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### put.responses.200.content.application/json.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### put.responses.200.content.application/json.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### put.responses.200.content.application/json.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### put.responses.200.content.application/json.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### put.responses.200.content.application/json.card\_name > **card\_name**: `string` ##### put.responses.200.content.application/json.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### put.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### put.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### put.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### put.responses.200.content.application/json.has\_been\_transferred? > `optional` **has\_been\_transferred?**: `boolean` ###### 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. ##### put.responses.200.content.application/json.id > **id**: `string` ##### put.responses.200.content.application/json.last\_four > **last\_four**: `string` ##### put.responses.200.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### put.responses.200.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### put.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### put.responses.200.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### put.responses.200.content.application/json.spend\_controls? > `optional` **spend\_controls?**: \{ `allowed_merchant_details?`: `object`[] \| `null`; `blocked_merchant_details?`: `object`[] \| `null`; `lock_after_date?`: `string` \| `null`; `reason?`: `string` \| `null`; `spend_available?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} \| `null` ###### Union Members ###### 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`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} ###### allowed\_merchant\_details? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_available? > `optional` **spend\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_limit?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### put.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` ##### put.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/cards/\{id\}/lock > **/v2/cards/\{id\}/lock**: `object` Defined in: [src/team/types.gen.ts:57](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L57) #### 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` Lock card ##### Description Locks an existing, unlocked card. And the card owner will receive a notification about it. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### post.parameters.path > **path**: `object` ##### post.parameters.path.id > **id**: `string` ##### 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? > `optional` **description?**: `string` \| `null` ###### Description Description for locking a card ##### post.requestBody.content.application/json.reason > **reason**: `"OTHER"` \| `"CARD_DAMAGED"` \| `"CARD_LOST"` \| `"CARD_NOT_RECEIVED"` \| `"DO_NOT_NEED_PHYSICAL_CARD"` \| `"DO_NOT_NEED_VIRTUAL_CARD"` \| `"FRAUD"` ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description lockCard 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### post.responses.200.content.application/json.card\_name > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### post.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? > `optional` **has\_been\_transferred?**: `boolean` ###### 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. ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.last\_four > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### post.responses.200.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### post.responses.200.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? > `optional` **spend\_controls?**: \{ `allowed_merchant_details?`: `object`[] \| `null`; `blocked_merchant_details?`: `object`[] \| `null`; `lock_after_date?`: `string` \| `null`; `reason?`: `string` \| `null`; `spend_available?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} \| `null` ###### Union Members ###### 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`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} ###### allowed\_merchant\_details? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_available? > `optional` **spend\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_limit?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/cards/\{id\}/pan > **/v2/cards/\{id\}/pan**: `object` Defined in: [src/team/types.gen.ts:77](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L77) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get card number ##### Description Retrieves card number, CVV, and expiration date of a card 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 getCardNumber 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.cvv > **cvv**: `string` ##### get.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### get.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### get.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### get.responses.200.content.application/json.holder\_name > **holder\_name**: `string` ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.number > **number**: `string` ##### get.responses.200.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` *** ### /v2/cards/\{id\}/secure\_email > **/v2/cards/\{id\}/secure\_email**: `object` Defined in: [src/team/types.gen.ts:97](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L97) #### 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` Create secure email to send card number ##### Description Creates a secure email to send card number, CVV, and expiration date of a card by ID to the specified email. This endpoint is currently gated. If you would like to request access, please reach out to developer-support@brex.com ##### 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 > **path**: `object` ##### post.parameters.path.id > **id**: `string` ##### 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.expiry\_days? > `optional` **expiry\_days?**: `number` \| `null` Format: int32 ###### Description Link expiry in number of days. Defaults to 30 ##### post.requestBody.content.application/json.message? > `optional` **message?**: `string` \| `null` ###### Description Message to send with the card details ##### post.requestBody.content.application/json.recipient\_email > **recipient\_email**: `string` ###### Description Email address to send card details to ##### post.requestBody.content.application/json.sender\_name > **sender\_name**: `string` ###### Description Sender name. Shows up in the subject of the email ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description emailCardNumber 200 response ##### post.responses.200.content? > `optional` **content?**: `undefined` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/cards/\{id\}/terminate > **/v2/cards/\{id\}/terminate**: `object` Defined in: [src/team/types.gen.ts:120](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L120) #### 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` Terminate card ##### Description Terminates an existing card. The card owner will receive a notification about it. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### post.parameters.path > **path**: `object` ##### post.parameters.path.id > **id**: `string` ##### 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? > `optional` **description?**: `string` \| `null` ###### Description Description for terminating a card ##### post.requestBody.content.application/json.reason > **reason**: `"OTHER"` \| `"CARD_DAMAGED"` \| `"CARD_LOST"` \| `"CARD_NOT_RECEIVED"` \| `"DO_NOT_NEED_PHYSICAL_CARD"` \| `"DO_NOT_NEED_VIRTUAL_CARD"` \| `"FRAUD"` ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description terminateCard 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### post.responses.200.content.application/json.card\_name > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### post.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? > `optional` **has\_been\_transferred?**: `boolean` ###### 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. ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.last\_four > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### post.responses.200.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### post.responses.200.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? > `optional` **spend\_controls?**: \{ `allowed_merchant_details?`: `object`[] \| `null`; `blocked_merchant_details?`: `object`[] \| `null`; `lock_after_date?`: `string` \| `null`; `reason?`: `string` \| `null`; `spend_available?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} \| `null` ###### Union Members ###### 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`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} ###### allowed\_merchant\_details? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_available? > `optional` **spend\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_limit?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/cards/\{id\}/unlock > **/v2/cards/\{id\}/unlock**: `object` Defined in: [src/team/types.gen.ts:140](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L140) #### 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` Unlock card ##### Description Unlocks an existing card. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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 unlockCard 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### post.responses.200.content.application/json.card\_name > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### post.responses.200.content.application/json.expiration\_date > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? > `optional` **has\_been\_transferred?**: `boolean` ###### 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. ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.last\_four > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### post.responses.200.content.application/json.mailing\_address? > `optional` **mailing\_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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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. ##### post.responses.200.content.application/json.owner > **owner**: `object` & `object` ###### Type Declaration ###### type > **type**: `"USER"` ###### user\_id > **user\_id**: `string` ###### Type Declaration ###### type > **type**: `"USER"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? > `optional` **spend\_controls?**: \{ `allowed_merchant_details?`: `object`[] \| `null`; `blocked_merchant_details?`: `object`[] \| `null`; `lock_after_date?`: `string` \| `null`; `reason?`: `string` \| `null`; `spend_available?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} \| `null` ###### Union Members ###### 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`: ... \| ...; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: ... \| ...; \} \| `null`; \} ###### allowed\_merchant\_details? > `optional` **allowed\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? > `optional` **blocked\_merchant\_details?**: `object`[] \| `null` ###### Description List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ###### reason? > `optional` **reason?**: `string` \| `null` ###### spend\_available? > `optional` **spend\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ###### spend\_limit? > `optional` **spend\_limit?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: ... \| ... ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/company > **/v2/company**: `object` Defined in: [src/team/types.gen.ts:160](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L160) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get company ##### Description This endpoint returns the company associated with the OAuth2 access token. ##### 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?**: `undefined` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description getCompany 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.accountType > **accountType**: `"BREX_CLASSIC"` \| `"BREX_EMPOWER"` ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.legal\_name > **legal\_name**: `string` ##### get.responses.200.content.application/json.mailing\_address > **mailing\_address**: `object` ##### get.responses.200.content.application/json.mailing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### get.responses.200.content.application/json.mailing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### get.responses.200.content.application/json.mailing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### get.responses.200.content.application/json.mailing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### get.responses.200.content.application/json.mailing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### get.responses.200.content.application/json.mailing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### get.responses.200.content.application/json.mailing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### get.responses.200.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` *** ### /v2/departments > **/v2/departments**: `object` Defined in: [src/team/types.gen.ts:180](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L180) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` List departments ##### Description This endpoint lists all departments. ##### 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.name? > `optional` **name?**: `string` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description listDepartments 200 response ##### 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` #### 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 department ##### Description This endpoint creates a new department ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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? > `optional` **description?**: `string` \| `null` ###### Description Description of the department ##### post.requestBody.content.application/json.name > **name**: `string` ###### Description Name of the department ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createDepartment 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the department ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.name > **name**: `string` ###### Description Name of the department ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/departments/\{id\} > **/v2/departments/\{id\}**: `object` Defined in: [src/team/types.gen.ts:204](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L204) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get department ##### Description This endpoint gets a department 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 getDepartmentById 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the department ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.name > **name**: `string` ###### Description Name of the department ##### get.responses.200.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` *** ### /v2/legal\_entities > **/v2/legal\_entities**: `object` Defined in: [src/team/types.gen.ts:224](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L224) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` List legal entities ##### Description List legal entities for the 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 listLegalEntities 200 response ##### 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` #### 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` *** ### /v2/legal\_entities/\{id\} > **/v2/legal\_entities/\{id\}**: `object` Defined in: [src/team/types.gen.ts:244](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L244) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get legal entity ##### Description Get a legal entity by its 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 getLegalEntity 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.billingAddress > **billingAddress**: `object` ##### get.responses.200.content.application/json.billingAddress.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### get.responses.200.content.application/json.billingAddress.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### get.responses.200.content.application/json.billingAddress.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### get.responses.200.content.application/json.billingAddress.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### get.responses.200.content.application/json.billingAddress.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### get.responses.200.content.application/json.billingAddress.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### get.responses.200.content.application/json.billingAddress.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### get.responses.200.content.application/json.createdAt > **createdAt**: `string` Format: date-time ###### Description Timestamp, in UTC, when this legal entity was created. ##### get.responses.200.content.application/json.displayName > **displayName**: `string` ###### Description The display name of this legal entity. ##### get.responses.200.content.application/json.id > **id**: `string` ###### Description The ID of this legal entity. ##### get.responses.200.content.application/json.isDefault? > `optional` **isDefault?**: `boolean` ###### Description Whether this is the default entity of the account. ##### get.responses.200.content.application/json.status > **status**: `"UNSUBMITTED"` \| `"UNVERIFIED"` \| `"IN_PROGRESS"` \| `"VERIFIED"` \| `"REJECTED"` ##### get.responses.200.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` *** ### /v2/locations > **/v2/locations**: `object` Defined in: [src/team/types.gen.ts:264](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L264) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` List locations ##### Description This endpoint lists all locations. ##### 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.name? > `optional` **name?**: `string` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description listLocations 200 response ##### 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` #### 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 location ##### Description This endpoint creates a new location. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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? > `optional` **description?**: `string` \| `null` ###### Description Description of the location ##### post.requestBody.content.application/json.name > **name**: `string` ###### Description Name of the location ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createLocation 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the location ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.name > **name**: `string` ###### Description Name of the location ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/locations/\{id\} > **/v2/locations/\{id\}**: `object` Defined in: [src/team/types.gen.ts:288](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L288) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get location ##### Description This endpoint gets a location 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 getLocationById 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the location ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.name > **name**: `string` ###### Description Name of the location ##### get.responses.200.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` *** ### /v2/titles > **/v2/titles**: `object` Defined in: [src/team/types.gen.ts:308](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L308) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` List titles ##### Description This endpoint lists all titles. ##### 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.name? > `optional` **name?**: `string` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description listTitles 200 response ##### 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` #### 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 title ##### Description This endpoint creates a new title ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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.name > **name**: `string` ###### Description Name of the title ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createTitle 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.name > **name**: `string` ###### Description Name of the title ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/titles/\{id\} > **/v2/titles/\{id\}**: `object` Defined in: [src/team/types.gen.ts:332](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L332) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get title ##### Description This endpoint gets a title 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 getTitleById 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.name > **name**: `string` ###### Description Name of the title ##### get.responses.200.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` *** ### /v2/users > **/v2/users**: `object` Defined in: [src/team/types.gen.ts:352](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L352) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` List users ##### Description This endpoint lists all users. To find a user id by email, you can filter using the `email` query parameter. ##### 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.email? > `optional` **email?**: `string` \| `null` ##### get.parameters.query.expand\[\]? > `optional` **expand\[\]?**: `string`[] \| `null` ##### get.parameters.query.limit? > `optional` **limit?**: `number` \| `null` ##### get.parameters.query.remote\_display\_id? > `optional` **remote\_display\_id?**: `string` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description listUsers 200 response ##### 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` #### 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` Invite user ##### Description This endpoint invites a new user as an employee. To update user's role, check out [this article](https://support.brex.com/how-do-i-change-another-user-s-role/). ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### post.requestBody.content.application/json.email > **email**: `string` Format: email ##### post.requestBody.content.application/json.first\_name > **first\_name**: `string` ##### post.requestBody.content.application/json.last\_name > **last\_name**: `string` ##### post.requestBody.content.application/json.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### post.requestBody.content.application/json.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ##### post.requestBody.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### post.requestBody.content.application/json.title\_id? > `optional` **title\_id?**: `string` \| `null` ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createUser 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### post.responses.200.content.application/json.email > **email**: `string` ###### Description Email address of the user ##### post.responses.200.content.application/json.first\_name > **first\_name**: `string` ###### Description First name of the user ##### post.responses.200.content.application/json.id > **id**: `string` ##### post.responses.200.content.application/json.last\_name > **last\_name**: `string` ###### Description Last name of the user ##### post.responses.200.content.application/json.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### post.responses.200.content.application/json.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### post.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### post.responses.200.content.application/json.remote\_display\_id? > `optional` **remote\_display\_id?**: `string` \| `null` ###### Description Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### post.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `"ARCHIVED"` \| `"DELETED"` \| `"INACTIVE"` \| `"INVITED"` \| `"PENDING_ACTIVATION"` \| `"CLOSED"` \| `null` ##### post.responses.200.content.application/json.title\_id? > `optional` **title\_id?**: `string` \| `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/users/\{id\} > **/v2/users/\{id\}**: `object` Defined in: [src/team/types.gen.ts:377](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L377) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get user ##### Description This endpoint gets a user 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 getUserById 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### get.responses.200.content.application/json.email > **email**: `string` ###### Description Email address of the user ##### get.responses.200.content.application/json.first\_name > **first\_name**: `string` ###### Description First name of the user ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.last\_name > **last\_name**: `string` ###### Description Last name of the user ##### get.responses.200.content.application/json.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### get.responses.200.content.application/json.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### get.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### get.responses.200.content.application/json.remote\_display\_id? > `optional` **remote\_display\_id?**: `string` \| `null` ###### Description Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### get.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `"ARCHIVED"` \| `"DELETED"` \| `"INACTIVE"` \| `"INVITED"` \| `"PENDING_ACTIVATION"` \| `"CLOSED"` \| `null` ##### get.responses.200.content.application/json.title\_id? > `optional` **title\_id?**: `string` \| `null` ##### get.responses.200.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 user ##### Description This endpoint updates a user. Any parameters not provided will be left unchanged. ##### put.parameters > **parameters**: `object` ##### put.parameters.cookie? > `optional` **cookie?**: `undefined` ##### put.parameters.header? > `optional` **header?**: `object` ##### put.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### 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.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### put.requestBody.content.application/json.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### put.requestBody.content.application/json.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### put.requestBody.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### put.requestBody.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `null` ##### put.requestBody.content.application/json.title\_id? > `optional` **title\_id?**: `string` \| `null` ##### put.responses > **responses**: `object` ##### put.responses.200 > **200**: `object` ###### Description updateUser 200 response ##### put.responses.200.content > **content**: `object` ##### put.responses.200.content.application/json > **application/json**: `object` ##### put.responses.200.content.application/json.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### put.responses.200.content.application/json.email > **email**: `string` ###### Description Email address of the user ##### put.responses.200.content.application/json.first\_name > **first\_name**: `string` ###### Description First name of the user ##### put.responses.200.content.application/json.id > **id**: `string` ##### put.responses.200.content.application/json.last\_name > **last\_name**: `string` ###### Description Last name of the user ##### put.responses.200.content.application/json.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### put.responses.200.content.application/json.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### put.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### put.responses.200.content.application/json.remote\_display\_id? > `optional` **remote\_display\_id?**: `string` \| `null` ###### Description Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### put.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `"ARCHIVED"` \| `"DELETED"` \| `"INACTIVE"` \| `"INVITED"` \| `"PENDING_ACTIVATION"` \| `"CLOSED"` \| `null` ##### put.responses.200.content.application/json.title\_id? > `optional` **title\_id?**: `string` \| `null` ##### put.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/users/\{id\}/limit > **/v2/users/\{id\}/limit**: `object` Defined in: [src/team/types.gen.ts:401](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L401) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get limit for the user ##### Description This endpoint gets the monthly limit for the user including the monthly available limit. ##### 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 getUserLimit 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.monthly\_available? > `optional` **monthly\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.monthly\_limit? > `optional` **monthly\_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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### get.responses.200.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` Set limit for the user ##### Description This endpoint sets the monthly limit for a user. The limit amount must be non-negative. To unset the monthly limit of the user, just set `monthly_limit` to null. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header? > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### post.parameters.path > **path**: `object` ##### post.parameters.path.id > **id**: `string` ##### 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.monthly\_limit? > `optional` **monthly\_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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description setUserLimit 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.monthly\_available? > `optional` **monthly\_available?**: \{ `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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### post.responses.200.content.application/json.monthly\_limit? > `optional` **monthly\_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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v2/users/me > **/v2/users/me**: `object` Defined in: [src/team/types.gen.ts:427](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L427) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get current user ##### Description This endpoint returns the user associated with the OAuth2 access token. ##### 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?**: `undefined` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description getMe 200 response ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### get.responses.200.content.application/json.email > **email**: `string` ###### Description Email address of the user ##### get.responses.200.content.application/json.first\_name > **first\_name**: `string` ###### Description First name of the user ##### get.responses.200.content.application/json.id > **id**: `string` ##### get.responses.200.content.application/json.last\_name > **last\_name**: `string` ###### Description Last name of the user ##### get.responses.200.content.application/json.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### get.responses.200.content.application/json.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### get.responses.200.content.application/json.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### get.responses.200.content.application/json.remote\_display\_id? > `optional` **remote\_display\_id?**: `string` \| `null` ###### Description Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### get.responses.200.content.application/json.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `"ARCHIVED"` \| `"DELETED"` \| `"INACTIVE"` \| `"INVITED"` \| `"PENDING_ACTIVATION"` \| `"CLOSED"` \| `null` ##### get.responses.200.content.application/json.title\_id? > `optional` **title\_id?**: `string` \| `null` ##### get.responses.200.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`