--- title: TeamComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/team/types.gen.ts:449](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L449) ## Properties ### headers > **headers**: `never` Defined in: [src/team/types.gen.ts:890](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L890) *** ### parameters > **parameters**: `never` Defined in: [src/team/types.gen.ts:888](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L888) *** ### pathItems > **pathItems**: `never` Defined in: [src/team/types.gen.ts:891](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L891) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/team/types.gen.ts:889](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L889) *** ### responses > **responses**: `never` Defined in: [src/team/types.gen.ts:887](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L887) *** ### schemas > **schemas**: `object` Defined in: [src/team/types.gen.ts:450](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L450) #### AccountType > **AccountType**: `"BREX_CLASSIC"` \| `"BREX_EMPOWER"` #### Address > **Address**: `object` ##### Description Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### Address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### Address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### Address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### Address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### Card > **Card**: `object` ##### Description Only cards with limit_type = CARD have spend_controls ##### Card.billing\_address > **billing\_address**: `object` ##### Card.billing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### Card.billing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### Card.billing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### Card.billing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### Card.billing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### Card.billing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### Card.billing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### Card.budget\_id? > `optional` **budget\_id?**: `string` \| `null` ##### Card.card\_name > **card\_name**: `string` ##### Card.card\_type? > `optional` **card\_type?**: `"VIRTUAL"` \| `"PHYSICAL"` \| `null` ##### Card.expiration\_date > **expiration\_date**: `object` ##### Card.expiration\_date.month > **month**: `number` Format: int32 ##### Card.expiration\_date.year > **year**: `number` Format: int32 ##### Card.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. ##### Card.id > **id**: `string` ##### Card.last\_four > **last\_four**: `string` ##### Card.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### Card.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` ##### Card.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. ##### Card.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 ##### Card.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`: `string` \| `null`; \} \| `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_available?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `spend_duration?`: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null`; `spend_limit?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; \} ###### allowed\_merchant\_details? > `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`: `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` ###### 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` ##### Card.status? > `optional` **status?**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` \| `null` #### CardAttributePreferences > **CardAttributePreferences**: `object` ##### CardAttributePreferences.three\_domain\_secure\_enabled\_preference? > `optional` **three\_domain\_secure\_enabled\_preference?**: `"THREE_DOMAIN_SECURE_ENABLED"` \| `"THREE_DOMAIN_SECURE_DISABLED"` \| `null` #### CardExpiration > **CardExpiration**: `object` ##### Description Card expiration year and month. Cards expire on the last day of the expiration month. The expiration date is in UTC for cards starting with 555671, 428803 and 485932. And the expiration date is in PST for cards starting with 511572. ##### CardExpiration.month > **month**: `number` Format: int32 ##### CardExpiration.year > **year**: `number` Format: int32 #### CardNumberResponse > **CardNumberResponse**: `object` ##### Description Card number, CVV, and expiration date of a card. ##### CardNumberResponse.cvv > **cvv**: `string` ##### CardNumberResponse.expiration\_date > **expiration\_date**: `object` ##### CardNumberResponse.expiration\_date.month > **month**: `number` Format: int32 ##### CardNumberResponse.expiration\_date.year > **year**: `number` Format: int32 ##### CardNumberResponse.holder\_name > **holder\_name**: `string` ##### CardNumberResponse.id > **id**: `string` ##### CardNumberResponse.number > **number**: `string` #### CardOwner > **CardOwner**: `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 #### CardStatus > **CardStatus**: `"ACTIVE"` \| `"TERMINATED"` \| `"SHIPPED"` \| `"LOCKED"` #### CardType > **CardType**: `"VIRTUAL"` \| `"PHYSICAL"` #### ChangeCardReason > **ChangeCardReason**: `"OTHER"` \| `"CARD_DAMAGED"` \| `"CARD_LOST"` \| `"CARD_NOT_RECEIVED"` \| `"DO_NOT_NEED_PHYSICAL_CARD"` \| `"DO_NOT_NEED_VIRTUAL_CARD"` \| `"FRAUD"` ##### Description Reason for card termination. #### CompanyResponse > **CompanyResponse**: `object` ##### CompanyResponse.accountType > **accountType**: `"BREX_CLASSIC"` \| `"BREX_EMPOWER"` ##### CompanyResponse.id > **id**: `string` ##### CompanyResponse.legal\_name > **legal\_name**: `string` ##### CompanyResponse.mailing\_address > **mailing\_address**: `object` ##### CompanyResponse.mailing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### CompanyResponse.mailing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### CompanyResponse.mailing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### CompanyResponse.mailing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### CompanyResponse.mailing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### CompanyResponse.mailing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### CompanyResponse.mailing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### CreateCardRequest > **CreateCardRequest**: `object` ##### Description The `spend_controls` field is required when `limit_type` = `CARD`. The `shipping_address` field is required for physical cards, and the first 2 lines of the address must be under 60 characters long. ##### CreateCardRequest.card\_attribute\_preferences? > `optional` **card\_attribute\_preferences?**: \{ `three_domain_secure_enabled_preference?`: `"THREE_DOMAIN_SECURE_ENABLED"` \| `"THREE_DOMAIN_SECURE_DISABLED"` \| `null`; \} \| `null` ##### CreateCardRequest.card\_name > **card\_name**: `string` ##### CreateCardRequest.card\_type > **card\_type**: `"VIRTUAL"` \| `"PHYSICAL"` ##### CreateCardRequest.limit\_type > **limit\_type**: `"CARD"` \| `"USER"` ##### CreateCardRequest.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` ##### CreateCardRequest.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. ##### CreateCardRequest.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 ##### CreateCardRequest.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` #### CreateDepartmentRequest > **CreateDepartmentRequest**: `object` ##### CreateDepartmentRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the department ##### CreateDepartmentRequest.name > **name**: `string` ###### Description Name of the department #### CreateLocationRequest > **CreateLocationRequest**: `object` ##### CreateLocationRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the location ##### CreateLocationRequest.name > **name**: `string` ###### Description Name of the location #### CreateTitleRequest > **CreateTitleRequest**: `object` ##### CreateTitleRequest.name > **name**: `string` ###### Description Name of the title #### CreateUserRequest > **CreateUserRequest**: `object` ##### CreateUserRequest.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### CreateUserRequest.email > **email**: `string` Format: email ##### CreateUserRequest.first\_name > **first\_name**: `string` ##### CreateUserRequest.last\_name > **last\_name**: `string` ##### CreateUserRequest.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### CreateUserRequest.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ##### CreateUserRequest.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### CreateUserRequest.title\_id? > `optional` **title\_id?**: `string` \| `null` #### DepartmentResponse > **DepartmentResponse**: `object` ##### DepartmentResponse.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the department ##### DepartmentResponse.id > **id**: `string` ##### DepartmentResponse.name > **name**: `string` ###### Description Name of the department #### LegalEntity > **LegalEntity**: `object` Legal Entity ##### Description A Brex legal entity. ##### LegalEntity.billingAddress > **billingAddress**: `object` ##### LegalEntity.billingAddress.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### LegalEntity.billingAddress.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### LegalEntity.billingAddress.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### LegalEntity.billingAddress.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### LegalEntity.billingAddress.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### LegalEntity.billingAddress.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### LegalEntity.billingAddress.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### LegalEntity.createdAt > **createdAt**: `string` Format: date-time ###### Description Timestamp, in UTC, when this legal entity was created. ##### LegalEntity.displayName > **displayName**: `string` ###### Description The display name of this legal entity. ##### LegalEntity.id > **id**: `string` ###### Description The ID of this legal entity. ##### LegalEntity.isDefault? > `optional` **isDefault?**: `boolean` ###### Description Whether this is the default entity of the account. ##### LegalEntity.status > **status**: `"UNSUBMITTED"` \| `"UNVERIFIED"` \| `"IN_PROGRESS"` \| `"VERIFIED"` \| `"REJECTED"` #### LegalEntityStatus > **LegalEntityStatus**: `"UNSUBMITTED"` \| `"UNVERIFIED"` \| `"IN_PROGRESS"` \| `"VERIFIED"` \| `"REJECTED"` ##### Description The possible statuses for an entity's verification in Brex. #### LimitType > **LimitType**: `"CARD"` \| `"USER"` ##### Description `limit_type = CARD` for vendor cards. Vendor cards must have a `card_type` of `VIRTUAL` and do not rely on the user specific limit. For corporate cards, `limit_type = USER`. Learn more about different card types [here](https://support.brex.com/what-are-the-different-types-of-cards-i-can-get/). #### LocationResponse > **LocationResponse**: `object` ##### LocationResponse.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the location ##### LocationResponse.id > **id**: `string` ##### LocationResponse.name > **name**: `string` ###### Description Name of the location #### LockCardRequest > **LockCardRequest**: `object` ##### Description Parameters for locking a card. ##### LockCardRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description for locking a card ##### LockCardRequest.reason > **reason**: `"OTHER"` \| `"CARD_DAMAGED"` \| `"CARD_LOST"` \| `"CARD_NOT_RECEIVED"` \| `"DO_NOT_NEED_PHYSICAL_CARD"` \| `"DO_NOT_NEED_VIRTUAL_CARD"` \| `"FRAUD"` #### LockedMerchantDetails > **LockedMerchantDetails**: `object` ##### Description Merchant details used for restricting or blocking transactions. ##### LockedMerchantDetails.name > **name**: `string` ###### Description The name of the merchant. ###### Example ```ts Github ``` #### Money > **Money**: `object` ##### Description Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount > **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 ``` ##### Money.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` #### OwnerType > **OwnerType**: `"USER"` #### Page\_Card\_ > **Page\_Card\_**: `object` ##### Page\_Card\_.items > **items**: `object`[] ##### Page\_Card\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_DepartmentResponse\_ > **Page\_DepartmentResponse\_**: `object` ##### Page\_DepartmentResponse\_.items > **items**: `object`[] ##### Page\_DepartmentResponse\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_LegalEntity\_ > **Page\_LegalEntity\_**: `object` ##### Page\_LegalEntity\_.items > **items**: `object`[] ##### Page\_LegalEntity\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_LocationResponse\_ > **Page\_LocationResponse\_**: `object` ##### Page\_LocationResponse\_.items > **items**: `object`[] ##### Page\_LocationResponse\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_TitleResponse\_ > **Page\_TitleResponse\_**: `object` ##### Page\_TitleResponse\_.items > **items**: `object`[] ##### Page\_TitleResponse\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_UserResponse\_ > **Page\_UserResponse\_**: `object` ##### Page\_UserResponse\_.items > **items**: `object`[] ##### Page\_UserResponse\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### SecureEmailForCardDetailsRequest > **SecureEmailForCardDetailsRequest**: `object` ##### SecureEmailForCardDetailsRequest.expiry\_days? > `optional` **expiry\_days?**: `number` \| `null` Format: int32 ###### Description Link expiry in number of days. Defaults to 30 ##### SecureEmailForCardDetailsRequest.message? > `optional` **message?**: `string` \| `null` ###### Description Message to send with the card details ##### SecureEmailForCardDetailsRequest.recipient\_email > **recipient\_email**: `string` ###### Description Email address to send card details to ##### SecureEmailForCardDetailsRequest.sender\_name > **sender\_name**: `string` ###### Description Sender name. Shows up in the subject of the email #### SetUserLimitRequest > **SetUserLimitRequest**: `object` ##### Description Request that sets the monthly user limit. ##### SetUserLimitRequest.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` #### SpendControl > **SpendControl**: `object` ##### SpendControl.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"}] ``` ##### SpendControl.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"}] ``` ##### SpendControl.lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ###### Description The `lock_after_date` is in UTC. ##### SpendControl.reason? > `optional` **reason?**: `string` \| `null` ##### SpendControl.spend\_available? > `optional` **spend\_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` ##### SpendControl.spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ##### SpendControl.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` #### SpendControlRequest > **SpendControlRequest**: `object` ##### Description When `limit_type = CARD`, `spend_controls` must be set. When `limit type = USER`, `spend_controls` must be `null`. ##### SpendControlRequest.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"}] ``` ##### SpendControlRequest.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"}] ``` ##### SpendControlRequest.lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ##### SpendControlRequest.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`. ##### SpendControlRequest.policy\_id? > `optional` **policy\_id?**: `string` \| `null` ##### SpendControlRequest.reason? > `optional` **reason?**: `string` \| `null` ##### SpendControlRequest.spend\_duration > **spend\_duration**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### SpendControlRequest.spend\_limit > **spend\_limit**: `object` ##### SpendControlRequest.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 ``` ##### SpendControlRequest.spend\_limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` #### SpendControlUpdateRequest > **SpendControlUpdateRequest**: `object` ##### SpendControlUpdateRequest.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"}] ``` ##### SpendControlUpdateRequest.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"}] ``` ##### SpendControlUpdateRequest.lock\_after\_date? > `optional` **lock\_after\_date?**: `string` \| `null` Format: date ##### SpendControlUpdateRequest.reason? > `optional` **reason?**: `string` \| `null` ##### SpendControlUpdateRequest.spend\_duration? > `optional` **spend\_duration?**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ##### SpendControlUpdateRequest.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` #### SpendDuration > **SpendDuration**: `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### Description Spend limit refresh frequency - MONTHLY: The spend limit refreshes every month - QUARTERLY: The spend limit refreshes every quarter - YEARLY: The spend limit refreshes every year - ONE_TIME: The limit does not refresh #### TerminateCardRequest > **TerminateCardRequest**: `object` ##### Description Parameters for terminating a card. ##### TerminateCardRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description for terminating a card ##### TerminateCardRequest.reason > **reason**: `"OTHER"` \| `"CARD_DAMAGED"` \| `"CARD_LOST"` \| `"CARD_NOT_RECEIVED"` \| `"DO_NOT_NEED_PHYSICAL_CARD"` \| `"DO_NOT_NEED_VIRTUAL_CARD"` \| `"FRAUD"` #### ThreeDomainSecureEnabledPreference > **ThreeDomainSecureEnabledPreference**: `"THREE_DOMAIN_SECURE_ENABLED"` \| `"THREE_DOMAIN_SECURE_DISABLED"` ##### Description Whether to enable 3-D secure protocol on this card. #### TitleResponse > **TitleResponse**: `object` ##### TitleResponse.id > **id**: `string` ##### TitleResponse.name > **name**: `string` ###### Description Name of the title #### UpdateCardRequest > **UpdateCardRequest**: `object` ##### UpdateCardRequest.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. ##### UpdateCardRequest.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` #### UpdateUserRequest > **UpdateUserRequest**: `object` ##### UpdateUserRequest.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### UpdateUserRequest.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### UpdateUserRequest.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### UpdateUserRequest.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### UpdateUserRequest.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `null` ##### UpdateUserRequest.title\_id? > `optional` **title\_id?**: `string` \| `null` #### UpdateUserStatus > **UpdateUserStatus**: `"ACTIVE"` \| `"DISABLED"` ##### Description Acceptable user status for update. To suspend a user, set status to 'disabled'. To unsuspend a user, set status to 'active'. #### UserLimitResponse > **UserLimitResponse**: `object` ##### UserLimitResponse.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` ##### UserLimitResponse.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` #### UserOwner > **UserOwner**: `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 #### UserResponse > **UserResponse**: `object` ##### UserResponse.department\_id? > `optional` **department\_id?**: `string` \| `null` ##### UserResponse.email > **email**: `string` ###### Description Email address of the user ##### UserResponse.first\_name > **first\_name**: `string` ###### Description First name of the user ##### UserResponse.id > **id**: `string` ##### UserResponse.last\_name > **last\_name**: `string` ###### Description Last name of the user ##### UserResponse.location\_id? > `optional` **location\_id?**: `string` \| `null` ##### UserResponse.manager\_id? > `optional` **manager\_id?**: `string` \| `null` ###### Description The user id of the manager of this user ##### UserResponse.metadata? > `optional` **metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### Description The metadata or customized attributes of the user. Maximum number of entries: 100 ##### UserResponse.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 ##### UserResponse.status? > `optional` **status?**: `"ACTIVE"` \| `"DISABLED"` \| `"ARCHIVED"` \| `"DELETED"` \| `"INACTIVE"` \| `"INVITED"` \| `"PENDING_ACTIVATION"` \| `"CLOSED"` \| `null` ##### UserResponse.title\_id? > `optional` **title\_id?**: `string` \| `null` #### UserStatus > **UserStatus**: `"ACTIVE"` \| `"DISABLED"` \| `"ARCHIVED"` \| `"DELETED"` \| `"INACTIVE"` \| `"INVITED"` \| `"PENDING_ACTIVATION"` \| `"CLOSED"` ##### Description Status of the user