--- title: BudgetsComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/budgets/types.gen.ts:249](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L249) ## Properties ### headers > **headers**: `never` Defined in: [src/budgets/types.gen.ts:985](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L985) *** ### parameters > **parameters**: `never` Defined in: [src/budgets/types.gen.ts:983](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L983) *** ### pathItems > **pathItems**: `never` Defined in: [src/budgets/types.gen.ts:986](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L986) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/budgets/types.gen.ts:984](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L984) *** ### responses > **responses**: `never` Defined in: [src/budgets/types.gen.ts:982](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L982) *** ### schemas > **schemas**: `object` Defined in: [src/budgets/types.gen.ts:250](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L250) #### AuthorizationSettings > **AuthorizationSettings**: `object` ##### AuthorizationSettings.authorization\_type > **authorization\_type**: `"HARD"` \| `"SOFT"` ##### AuthorizationSettings.base\_limit > **base\_limit**: `object` ##### AuthorizationSettings.base\_limit.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### AuthorizationSettings.base\_limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### AuthorizationSettings.limit\_buffer\_percentage? > `optional` **limit\_buffer\_percentage?**: `number` \| `null` Format: int32 ###### Description The percentage of flexible buffer on the limit as a 0-100 integer. ##### AuthorizationSettings.limit\_with\_increases > **limit\_with\_increases**: `object` ##### AuthorizationSettings.limit\_with\_increases.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### AuthorizationSettings.limit\_with\_increases.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### AuthorizationSettings.rollover\_refresh\_rate > **rollover\_refresh\_rate**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` #### AuthorizationType > **AuthorizationType**: `"HARD"` \| `"SOFT"` ##### Description Whether authorizations will decline based on available balance. #### AuthorizationVisibility > **AuthorizationVisibility**: `"PUBLIC"` \| `"PRIVATE"` ##### Description Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral). #### AutoCreateLimitCardsSetting > **AutoCreateLimitCardsSetting**: `"DISABLED"` \| `"ALL_MEMBERS"` ##### Description Setting for how auto limit card creation works for members. #### AutoTransferCardsSetting > **AutoTransferCardsSetting**: `"DISABLED"` \| `"ENABLED"` ##### Description Setting for how auto transfer works for virtual cards. #### Budget > **Budget**: `object` ##### Budget.account\_id > **account\_id**: `string` ###### Description The Brex account this Spend Limit belongs to. ##### Budget.budget\_id > **budget\_id**: `string` ###### Description Unique ID for the Spend Limit. ##### Budget.budget\_status > **budget\_status**: `"DELETED"` \| `"APPROVED"` \| `"EXPIRED"` \| `"TERMINATED"` ##### Budget.budget\_type > **budget\_type**: `"BUDGET"` \| `"SPEND_LIMIT"` ##### Budget.creator\_user\_id? > `optional` **creator\_user\_id?**: `string` \| `null` ###### Description The ID of the user who originally created this Spend Limit. ##### Budget.current\_period\_balance? > `optional` **current\_period\_balance?**: \{ `balance?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `end_date?`: `string` \| `null`; `start_date?`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `balance?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `end_date?`: `string` \| `null`; `start_date?`: `string` \| `null`; \} ###### balance? > `optional` **balance?**: \{ `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` ###### end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date *** `null` ##### Budget.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### Budget.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should stop counting. ##### Budget.limit? > `optional` **limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### Budget.limit\_type? > `optional` **limit\_type?**: `"HARD"` \| `"SOFT"` \| `null` ##### Budget.limit\_visibility > **limit\_visibility**: `"PRIVATE"` \| `"SHARED"` ##### Budget.member\_user\_ids > **member\_user\_ids**: `string`[] ###### Description User IDs of the members of the Spend Limit. ##### Budget.name > **name**: `string` ###### Description Name for the Spend Limit. ##### Budget.owner\_user\_ids > **owner\_user\_ids**: `string`[] ###### Description User IDs of the owners of the Spend Limit. ##### Budget.parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### Description ID of parent Budget. ##### Budget.period\_type > **period\_type**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### Budget.spend\_type > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### Budget.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should start counting. ##### Budget.templateId? > `optional` **templateId?**: `string` \| `null` #### BudgetBlueprint > **BudgetBlueprint**: `object` ##### Description Blueprint for provisioning Spend Limits for a Budget Program. ##### BudgetBlueprint.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### BudgetBlueprint.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should stop counting. ##### BudgetBlueprint.id > **id**: `string` ##### BudgetBlueprint.limit? > `optional` **limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### BudgetBlueprint.limit\_type > **limit\_type**: `"HARD"` \| `"SOFT"` ##### BudgetBlueprint.limit\_visibility > **limit\_visibility**: `"PRIVATE"` \| `"SHARED"` ##### BudgetBlueprint.name > **name**: `string` ###### Description Name for the Spend Limit. ##### BudgetBlueprint.owner\_user\_ids > **owner\_user\_ids**: `string`[] ###### Description User IDs of the owners of the Spend Limit. ##### BudgetBlueprint.parent\_budget\_id > **parent\_budget\_id**: `string` ###### Description ID of parent Budget. ##### BudgetBlueprint.period\_type > **period\_type**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### BudgetBlueprint.spend\_type > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### BudgetBlueprint.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should start counting. #### BudgetLimitVisibilityType > **BudgetLimitVisibilityType**: `"PRIVATE"` \| `"SHARED"` ##### Description Determines if Spend Limit members are allowed to view the Spend Limit's limit. #### BudgetPeriodBalance > **BudgetPeriodBalance**: `object` ##### Description Current Spend Limit period balance. ##### BudgetPeriodBalance.balance? > `optional` **balance?**: \{ `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` ##### BudgetPeriodBalance.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ##### BudgetPeriodBalance.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date #### BudgetProgram > **BudgetProgram**: `object` ##### Description Budget Program used to create Spend Limits for eligible users. ##### BudgetProgram.budget\_blueprints > **budget\_blueprints**: `object`[] ##### BudgetProgram.budget\_program\_status > **budget\_program\_status**: `"BUDGET_PROGRAM_STATUS_ACTIVE"` \| `"BUDGET_PROGRAM_STATUS_INACTIVE"` \| `"BUDGET_PROGRAM_STATUS_DELETED"` ##### BudgetProgram.created\_at > **created\_at**: `string` Format: date ##### BudgetProgram.creator\_user\_id? > `optional` **creator\_user\_id?**: `string` \| `null` ##### BudgetProgram.description? > `optional` **description?**: `string` \| `null` ##### BudgetProgram.employee\_filter? > `optional` **employee\_filter?**: \{ `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` \| `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` \| `null`; \} \| `null` ##### BudgetProgram.existing\_budget\_ids? > `optional` **existing\_budget\_ids?**: `string`[] \| `null` ###### Description IDs for existing Spend Limits associated with this Budget Program. ##### BudgetProgram.id > **id**: `string` ##### BudgetProgram.name > **name**: `string` ##### BudgetProgram.updated\_at > **updated\_at**: `string` Format: date #### BudgetProgramStatus > **BudgetProgramStatus**: `"BUDGET_PROGRAM_STATUS_ACTIVE"` \| `"BUDGET_PROGRAM_STATUS_INACTIVE"` \| `"BUDGET_PROGRAM_STATUS_DELETED"` #### BudgetStatus > **BudgetStatus**: `"DELETED"` \| `"APPROVED"` \| `"EXPIRED"` \| `"TERMINATED"` ##### Description Status of the Spend Limit e.g. APPROVED. #### BudgetType > **BudgetType**: `"BUDGET"` \| `"SPEND_LIMIT"` ##### Description Whether this is a Budget or a Spend Limit for post-bifurcation entities. #### CreateAuthorizationSettings > **CreateAuthorizationSettings**: `object` ##### CreateAuthorizationSettings.authorization\_type > **authorization\_type**: `"HARD"` \| `"SOFT"` ##### CreateAuthorizationSettings.base\_limit > **base\_limit**: `object` ##### CreateAuthorizationSettings.base\_limit.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### CreateAuthorizationSettings.base\_limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateAuthorizationSettings.limit\_buffer\_percentage? > `optional` **limit\_buffer\_percentage?**: `number` \| `null` Format: int32 ###### Description The percentage of flexible buffer on the limit as a 0-100 integer. ##### CreateAuthorizationSettings.rollover\_refresh\_rate > **rollover\_refresh\_rate**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` #### CreateBudgetBlueprintRequest > **CreateBudgetBlueprintRequest**: `object` ##### Description Blueprint for provisioning Spend Limits for a Budget Program. ##### CreateBudgetBlueprintRequest.description > **description**: `string` ###### Description Description of what the Spend Limit is used for. ##### CreateBudgetBlueprintRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should stop counting. ##### CreateBudgetBlueprintRequest.limit > **limit**: `object` ##### CreateBudgetBlueprintRequest.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 ``` ##### CreateBudgetBlueprintRequest.limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateBudgetBlueprintRequest.limit\_type > **limit\_type**: `"HARD"` \| `"SOFT"` ##### CreateBudgetBlueprintRequest.limit\_visibility > **limit\_visibility**: `"PRIVATE"` \| `"SHARED"` ##### CreateBudgetBlueprintRequest.name > **name**: `string` ###### Description Name for the Spend Limit. ##### CreateBudgetBlueprintRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Spend Limit. ##### CreateBudgetBlueprintRequest.parent\_budget\_id > **parent\_budget\_id**: `string` ###### Description ID of parent Budget. ##### CreateBudgetBlueprintRequest.period\_type > **period\_type**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### CreateBudgetBlueprintRequest.spend\_type > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### CreateBudgetBlueprintRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should start counting. #### CreateBudgetProgramRequest > **CreateBudgetProgramRequest**: `object` ##### Description Budget Program used to create Spend Limits for eligible users. ##### CreateBudgetProgramRequest.budget\_blueprints > **budget\_blueprints**: `object`[] ##### CreateBudgetProgramRequest.description? > `optional` **description?**: `string` \| `null` ##### CreateBudgetProgramRequest.employee\_filter? > `optional` **employee\_filter?**: \{ `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` \| `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` \| `null`; \} \| `null` ##### CreateBudgetProgramRequest.existing\_budget\_ids? > `optional` **existing\_budget\_ids?**: `string`[] \| `null` ###### Description IDs for existing Spend Limits associated with this Budget Program. ##### CreateBudgetProgramRequest.name > **name**: `string` #### CreateBudgetRequest > **CreateBudgetRequest**: `object` ##### CreateBudgetRequest.description > **description**: `string` ###### Description Description of what the Spend Limit is used for. ##### CreateBudgetRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should stop counting. ##### CreateBudgetRequest.entity\_id? > `optional` **entity\_id?**: `string` \| `null` ##### CreateBudgetRequest.limit > **limit**: `object` ##### CreateBudgetRequest.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 ``` ##### CreateBudgetRequest.limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateBudgetRequest.limit\_type > **limit\_type**: `"HARD"` \| `"SOFT"` ##### CreateBudgetRequest.limit\_visibility > **limit\_visibility**: `"PRIVATE"` \| `"SHARED"` ##### CreateBudgetRequest.member\_user\_ids? > `optional` **member\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the members of the Spend Limit. ##### CreateBudgetRequest.name > **name**: `string` ###### Description Name for the Spend Limit. ##### CreateBudgetRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Spend Limit. ##### CreateBudgetRequest.parent\_budget\_id > **parent\_budget\_id**: `string` ###### Description ID of parent Budget. ##### CreateBudgetRequest.period\_type > **period\_type**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### CreateBudgetRequest.policy\_id? > `optional` **policy\_id?**: `string` \| `null` ##### CreateBudgetRequest.spend\_type > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### CreateBudgetRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should start counting. #### CreateSpendBudgetRequest > **CreateSpendBudgetRequest**: `object` ##### CreateSpendBudgetRequest.amount > **amount**: `object` ##### CreateSpendBudgetRequest.amount.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### CreateSpendBudgetRequest.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateSpendBudgetRequest.description > **description**: `string` ###### Description Description of what the Budget is used for. ##### CreateSpendBudgetRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The date when the Budget should stop counting. ##### CreateSpendBudgetRequest.limit\_type? > `optional` **limit\_type?**: `"HARD"` \| `"SOFT"` \| `null` :::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: ##### CreateSpendBudgetRequest.name > **name**: `string` ###### Description Name for the Budget. ##### CreateSpendBudgetRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Budget. ##### CreateSpendBudgetRequest.parent\_budget\_id > **parent\_budget\_id**: `string` ###### Description ID of parent Budget. ##### CreateSpendBudgetRequest.period\_recurrence\_type > **period\_recurrence\_type**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### CreateSpendBudgetRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The date when the Budget should start counting. #### CreateSpendLimitRequest > **CreateSpendLimitRequest**: `object` ##### CreateSpendLimitRequest.authorization\_settings > **authorization\_settings**: `object` ##### CreateSpendLimitRequest.authorization\_settings.authorization\_type > **authorization\_type**: `"HARD"` \| `"SOFT"` ##### CreateSpendLimitRequest.authorization\_settings.base\_limit > **base\_limit**: `object` ##### CreateSpendLimitRequest.authorization\_settings.base\_limit.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### CreateSpendLimitRequest.authorization\_settings.base\_limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateSpendLimitRequest.authorization\_settings.limit\_buffer\_percentage? > `optional` **limit\_buffer\_percentage?**: `number` \| `null` Format: int32 ###### Description The percentage of flexible buffer on the limit as a 0-100 integer. ##### CreateSpendLimitRequest.authorization\_settings.rollover\_refresh\_rate > **rollover\_refresh\_rate**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` ##### CreateSpendLimitRequest.authorization\_visibility > **authorization\_visibility**: `"PUBLIC"` \| `"PRIVATE"` ##### CreateSpendLimitRequest.auto\_create\_limit\_cards\_setting > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` \| `"ALL_MEMBERS"` ##### CreateSpendLimitRequest.auto\_transfer\_cards\_setting > **auto\_transfer\_cards\_setting**: `"DISABLED"` \| `"ENABLED"` ##### CreateSpendLimitRequest.department\_id? > `optional` **department\_id?**: `string` \| `null` ###### Description The department ID to which Spend Limit expenses will be attributed. ##### CreateSpendLimitRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### CreateSpendLimitRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The date when the Spend Limit should expire. ##### CreateSpendLimitRequest.expense\_policy\_id > **expense\_policy\_id**: `string` ###### Description The ID of the expense policy corresponding to this Spend Limit. ##### CreateSpendLimitRequest.expense\_visibility > **expense\_visibility**: `"PRIVATE"` \| `"SHARED"` ##### CreateSpendLimitRequest.legal\_entity\_id? > `optional` **legal\_entity\_id?**: `string` \| `null` ###### Description The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user's entity. ##### CreateSpendLimitRequest.limit\_approval\_policy\_id? > `optional` **limit\_approval\_policy\_id?**: `string` \| `null` ###### Description The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id. ##### CreateSpendLimitRequest.limit\_increase\_request\_policy\_id? > `optional` **limit\_increase\_request\_policy\_id?**: `string` \| `null` ###### Description The ID of the policy for limit increase requests for this Spend Limit. ##### CreateSpendLimitRequest.limit\_increase\_setting > **limit\_increase\_setting**: `"DISABLED"` \| `"ENABLED"` ##### CreateSpendLimitRequest.member\_user\_ids? > `optional` **member\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the members of the Spend Limit. ##### CreateSpendLimitRequest.name > **name**: `string` ###### Description Name for the Spend Limit. ##### CreateSpendLimitRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Spend Limit. ##### CreateSpendLimitRequest.parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### Description ID of parent Budget. ##### CreateSpendLimitRequest.period\_recurrence\_type > **period\_recurrence\_type**: `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `"ONE_TIME"` \| `"PER_WEEK"` ##### CreateSpendLimitRequest.spend\_type > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### CreateSpendLimitRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The date when the Spend Limit should start counting. ##### CreateSpendLimitRequest.transaction\_limit? > `optional` **transaction\_limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` #### EmployeeFilter > **EmployeeFilter**: `object` ##### Description A filter used to determine if a user adheres to a Budget Program. ##### EmployeeFilter.employment\_status? > `optional` **employment\_status?**: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` \| `null` ##### EmployeeFilter.employment\_type? > `optional` **employment\_type?**: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` \| `null` #### EmploymentStatus > **EmploymentStatus**: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` ##### Description A filter used to determine if a user adheres to a Budget Program. #### EmploymentType > **EmploymentType**: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` ##### Description What kind of employment the employee has. #### ExpenseVisibility > **ExpenseVisibility**: `"PRIVATE"` \| `"SHARED"` ##### Description Whether or not expense related to this Spend Limit should be viewable to all members. #### LimitIncreaseSetting > **LimitIncreaseSetting**: `"DISABLED"` \| `"ENABLED"` ##### Description Whether or not members can request limit increases. #### LimitType > **LimitType**: `"HARD"` \| `"SOFT"` ##### Description Whether the Spend Limit's limit blocks spend. #### LimitType\_1 > **LimitType\_1**: `"HARD"` \| `"SOFT"` ##### Description Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. #### LimitType\_3 > **LimitType\_3**: `"HARD"` \| `"SOFT"` ##### Description Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. #### LimitType\_4 > **LimitType\_4**: `"HARD"` \| `"SOFT"` ##### Description Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. #### MerchantCategory > **MerchantCategory**: `"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"` #### MerchantCategoryControls > **MerchantCategoryControls**: `object` ##### MerchantCategoryControls.allowed\_merchant\_categories? > `optional` **allowed\_merchant\_categories?**: (`"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"`)[] \| `null` ##### MerchantCategoryControls.blocked\_merchant\_categories? > `optional` **blocked\_merchant\_categories?**: (`"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"`)[] \| `null` #### 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 ``` #### Page\_Budget\_ > **Page\_Budget\_**: `object` ##### Page\_Budget\_.items > **items**: `object`[] ##### Page\_Budget\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_BudgetProgram\_ > **Page\_BudgetProgram\_**: `object` ##### Page\_BudgetProgram\_.items > **items**: `object`[] ##### Page\_BudgetProgram\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_SpendBudget\_ > **Page\_SpendBudget\_**: `object` ##### Page\_SpendBudget\_.items > **items**: `object`[] ##### Page\_SpendBudget\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_SpendLimit\_ > **Page\_SpendLimit\_**: `object` ##### Page\_SpendLimit\_.items > **items**: `object`[] ##### Page\_SpendLimit\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### PeriodRecurrenceType > **PeriodRecurrenceType**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### Description Period type of the Budget e.g. MONTHLY. #### PeriodType > **PeriodType**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### Description Period type of the Spend Limit e.g. MONTHLY. #### RolloverRefreshRate > **RolloverRefreshRate**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` ##### Description The rollover refresh rate for this spend limit (the recurrence by which all rolled over unused funds within the cycle should no longer roll over to the next period). #### SpendBudget > **SpendBudget**: `object` ##### SpendBudget.account\_id > **account\_id**: `string` ###### Description The Brex account this Budget belongs to. ##### SpendBudget.amount? > `optional` **amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### SpendBudget.budget\_id > **budget\_id**: `string` ###### Description Unique ID for the Budget. ##### SpendBudget.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Budget is used for. ##### SpendBudget.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The date when the Budget should stop counting. ##### SpendBudget.limit\_type? > `optional` **limit\_type?**: `"HARD"` \| `"SOFT"` \| `null` :::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: ##### SpendBudget.name > **name**: `string` ###### Description Name for the Budget. ##### SpendBudget.owner\_user\_ids > **owner\_user\_ids**: `string`[] ###### Description User IDs of the owners of the Budget. ##### SpendBudget.parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### Description ID of parent Budget. ##### SpendBudget.period\_recurrence\_type > **period\_recurrence\_type**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` ##### SpendBudget.spend\_budget\_status > **spend\_budget\_status**: `"ACTIVE"` \| `"ARCHIVED"` \| `"DELETED"` \| `"EXPIRED"` ##### SpendBudget.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The date when the Budget should start counting. #### SpendBudgetStatus > **SpendBudgetStatus**: `"ACTIVE"` \| `"ARCHIVED"` \| `"DELETED"` \| `"EXPIRED"` ##### Description Status of the Budget e.g. ACTIVE. #### SpendLimit > **SpendLimit**: `object` ##### SpendLimit.account\_id > **account\_id**: `string` ###### Description The Brex account this Spend Limit belongs to. ##### SpendLimit.authorization\_settings? > `optional` **authorization\_settings?**: \{ `authorization_type`: `"HARD"` \| `"SOFT"`; `base_limit`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `limit_buffer_percentage?`: `number` \| `null`; `limit_with_increases`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `rollover_refresh_rate`: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"`; \} \| `null` ###### Union Members ###### Type Literal \{ `authorization_type`: `"HARD"` \| `"SOFT"`; `base_limit`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `limit_buffer_percentage?`: `number` \| `null`; `limit_with_increases`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `rollover_refresh_rate`: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"`; \} ###### authorization\_type > **authorization\_type**: `"HARD"` \| `"SOFT"` ###### base\_limit > **base\_limit**: `object` ###### base\_limit.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### base\_limit.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ###### limit\_buffer\_percentage? > `optional` **limit\_buffer\_percentage?**: `number` \| `null` Format: int32 ###### Description The percentage of flexible buffer on the limit as a 0-100 integer. ###### limit\_with\_increases > **limit\_with\_increases**: `object` ###### limit\_with\_increases.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### limit\_with\_increases.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ###### rollover\_refresh\_rate > **rollover\_refresh\_rate**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` *** `null` ##### SpendLimit.authorization\_visibility > **authorization\_visibility**: `"PUBLIC"` \| `"PRIVATE"` ##### SpendLimit.auto\_create\_limit\_cards\_setting > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` \| `"ALL_MEMBERS"` ##### SpendLimit.auto\_transfer\_cards\_setting > **auto\_transfer\_cards\_setting**: `"DISABLED"` \| `"ENABLED"` ##### SpendLimit.current\_period\_balance? > `optional` **current\_period\_balance?**: \{ `amount_spent?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `end_date?`: `string` \| `null`; `end_time?`: `string` \| `null`; `rollover_amount?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `start_date?`: `string` \| `null`; `start_time?`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount_spent?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `end_date?`: `string` \| `null`; `end_time?`: `string` \| `null`; `rollover_amount?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `start_date?`: `string` \| `null`; `start_time?`: `string` \| `null`; \} ###### amount\_spent? > `optional` **amount\_spent?**: \{ `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` ###### end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### end\_time? > `optional` **end\_time?**: `string` \| `null` Format: date-time ###### rollover\_amount? > `optional` **rollover\_amount?**: \{ `amount`: `number`; `currency`: `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` ###### start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### start\_time? > `optional` **start\_time?**: `string` \| `null` Format: date-time *** `null` ##### SpendLimit.department\_id? > `optional` **department\_id?**: `string` \| `null` ###### Description The department ID to which Spend Limit expenses will be attributed. ##### SpendLimit.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### SpendLimit.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The date when the Spend Limit should expire. ##### SpendLimit.end\_time\_utc? > `optional` **end\_time\_utc?**: `string` \| `null` Format: date-time ###### Description The UTC time when the Spend Limit should expire. ##### SpendLimit.expense\_policy\_id > **expense\_policy\_id**: `string` ###### Description The ID of the expense policy corresponding to this Spend Limit. ##### SpendLimit.expense\_visibility > **expense\_visibility**: `"PRIVATE"` \| `"SHARED"` ##### SpendLimit.id > **id**: `string` ###### Description Unique ID for the Spend Limit. ##### SpendLimit.legal\_entity\_id? > `optional` **legal\_entity\_id?**: `string` \| `null` ###### Description The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user's entity. ##### SpendLimit.limit\_approval\_policy\_id? > `optional` **limit\_approval\_policy\_id?**: `string` \| `null` ###### Description The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id. ##### SpendLimit.limit\_increase\_request\_policy\_id? > `optional` **limit\_increase\_request\_policy\_id?**: `string` \| `null` ###### Description The ID of the policy for limit increase requests for this Spend Limit. ##### SpendLimit.limit\_increase\_setting > **limit\_increase\_setting**: `"DISABLED"` \| `"ENABLED"` ##### SpendLimit.member\_user\_ids > **member\_user\_ids**: `string`[] ###### Description User IDs of the members of the Spend Limit. ##### SpendLimit.merchant\_category\_controls? > `optional` **merchant\_category\_controls?**: \{ `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"`)[] \| `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"`)[] \| `null`; \} \| `null` ##### SpendLimit.name > **name**: `string` ###### Description Name for the Spend Limit. ##### SpendLimit.owner\_user\_ids > **owner\_user\_ids**: `string`[] ###### Description User IDs of the owners of the Spend Limit. ##### SpendLimit.parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### Description ID of parent Budget. ##### SpendLimit.period\_recurrence\_type > **period\_recurrence\_type**: `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `"ONE_TIME"` \| `"PER_WEEK"` ##### SpendLimit.spend\_type > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### SpendLimit.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The date when the Spend Limit should start counting. ##### SpendLimit.start\_time\_utc? > `optional` **start\_time\_utc?**: `string` \| `null` Format: date-time ###### Description The UTC time when the Spend Limit should start counting. ##### SpendLimit.status > **status**: `"ACTIVE"` \| `"ARCHIVED"` \| `"DELETED"` \| `"EXPIRED"` ##### SpendLimit.transaction\_limit? > `optional` **transaction\_limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` #### SpendLimitPeriodBalance > **SpendLimitPeriodBalance**: `object` ##### SpendLimitPeriodBalance.amount\_spent? > `optional` **amount\_spent?**: \{ `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` ##### SpendLimitPeriodBalance.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ##### SpendLimitPeriodBalance.end\_time? > `optional` **end\_time?**: `string` \| `null` Format: date-time ##### SpendLimitPeriodBalance.rollover\_amount? > `optional` **rollover\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### SpendLimitPeriodBalance.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ##### SpendLimitPeriodBalance.start\_time? > `optional` **start\_time?**: `string` \| `null` Format: date-time #### SpendLimitPeriodRecurrenceType > **SpendLimitPeriodRecurrenceType**: `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `"ONE_TIME"` \| `"PER_WEEK"` ##### Description Period type of the Spend Limit e.g. MONTHLY. #### SpendLimitStatus > **SpendLimitStatus**: `"ACTIVE"` \| `"ARCHIVED"` \| `"DELETED"` \| `"EXPIRED"` ##### Description Status of the Spend Limit e.g. ACTIVE. #### SpendType > **SpendType**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### Description Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. #### UpdateAuthorizationSettings > **UpdateAuthorizationSettings**: `object` ##### UpdateAuthorizationSettings.authorization\_type? > `optional` **authorization\_type?**: `"HARD"` \| `"SOFT"` \| `null` ##### UpdateAuthorizationSettings.base\_limit? > `optional` **base\_limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### UpdateAuthorizationSettings.limit\_buffer\_percentage? > `optional` **limit\_buffer\_percentage?**: `number` \| `null` Format: int32 ###### Description The percentage of flexible buffer on the limit as a 0-100 integer. ##### UpdateAuthorizationSettings.rollover\_refresh\_rate? > `optional` **rollover\_refresh\_rate?**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `null` #### UpdateBudgetBlueprintRequest > **UpdateBudgetBlueprintRequest**: `object` ##### Description Blueprint for provisioning Spend Limits for a Budget Program. ##### UpdateBudgetBlueprintRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### UpdateBudgetBlueprintRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should stop counting. ##### UpdateBudgetBlueprintRequest.id? > `optional` **id?**: `string` \| `null` ###### Description ID of budget blueprint to update, omit if adding new budget blueprint to budget program. ##### UpdateBudgetBlueprintRequest.limit? > `optional` **limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### UpdateBudgetBlueprintRequest.limit\_type? > `optional` **limit\_type?**: `"HARD"` \| `"SOFT"` \| `null` ##### UpdateBudgetBlueprintRequest.name? > `optional` **name?**: `string` \| `null` ###### Description Name for the Spend Limit. ##### UpdateBudgetBlueprintRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Spend Limit. ##### UpdateBudgetBlueprintRequest.parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### Description ID of parent Budget. ##### UpdateBudgetBlueprintRequest.period\_type? > `optional` **period\_type?**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ##### UpdateBudgetBlueprintRequest.spend\_type? > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` \| `null` ##### UpdateBudgetBlueprintRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should start counting. #### UpdateBudgetProgramRequest > **UpdateBudgetProgramRequest**: `object` ##### Description Budget Program used to create Spend Limits for eligible users. ##### UpdateBudgetProgramRequest.budget\_blueprints? > `optional` **budget\_blueprints?**: `object`[] \| `null` ###### Description The Blueprints to update the budget program with. Blueprints without an ID are treated as new blueprints to be created. Blueprints that exist currently on the Budget Program, but are missing from the input, will be deleted. ##### UpdateBudgetProgramRequest.description? > `optional` **description?**: `string` \| `null` ##### UpdateBudgetProgramRequest.employee\_filter? > `optional` **employee\_filter?**: \{ `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` \| `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` \| `null`; \} \| `null` ##### UpdateBudgetProgramRequest.existing\_budget\_ids? > `optional` **existing\_budget\_ids?**: `string`[] \| `null` ###### Description IDs for existing Spend Limits associated with this Budget Program. ##### UpdateBudgetProgramRequest.name? > `optional` **name?**: `string` \| `null` #### UpdateBudgetRequest > **UpdateBudgetRequest**: `object` ##### UpdateBudgetRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### UpdateBudgetRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should stop counting. ##### UpdateBudgetRequest.limit? > `optional` **limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### UpdateBudgetRequest.limit\_type? > `optional` **limit\_type?**: `"HARD"` \| `"SOFT"` \| `null` ##### UpdateBudgetRequest.limit\_visibility? > `optional` **limit\_visibility?**: `"PRIVATE"` \| `"SHARED"` \| `null` ##### UpdateBudgetRequest.member\_user\_ids? > `optional` **member\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the members of the Spend Limit. ##### UpdateBudgetRequest.name? > `optional` **name?**: `string` \| `null` ###### Description Name for the Spend Limit. ##### UpdateBudgetRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Spend Limit. ##### UpdateBudgetRequest.period\_type? > `optional` **period\_type?**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ##### UpdateBudgetRequest.spend\_type? > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` \| `null` ##### UpdateBudgetRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The UTC date when the Spend Limit should start counting. #### UpdateSpendBudgetRequest > **UpdateSpendBudgetRequest**: `object` ##### UpdateSpendBudgetRequest.amount? > `optional` **amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### UpdateSpendBudgetRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Budget is used for. ##### UpdateSpendBudgetRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The date when the Budget should stop counting. ##### UpdateSpendBudgetRequest.limit\_type? > `optional` **limit\_type?**: `"HARD"` \| `"SOFT"` \| `null` :::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: ##### UpdateSpendBudgetRequest.name? > `optional` **name?**: `string` \| `null` ###### Description Name for the Budget. ##### UpdateSpendBudgetRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Budget. ##### UpdateSpendBudgetRequest.parent\_budget\_id? > `optional` **parent\_budget\_id?**: `string` \| `null` ###### Description ID of parent Budget. ##### UpdateSpendBudgetRequest.period\_recurrence\_type? > `optional` **period\_recurrence\_type?**: `"WEEKLY"` \| `"MONTHLY"` \| `"QUARTERLY"` \| `"YEARLY"` \| `"ONE_TIME"` \| `null` ##### UpdateSpendBudgetRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The date when the Budget should start counting. #### UpdateSpendLimitRequest > **UpdateSpendLimitRequest**: `object` ##### UpdateSpendLimitRequest.authorization\_settings? > `optional` **authorization\_settings?**: \{ `authorization_type?`: `"HARD"` \| `"SOFT"` \| `null`; `base_limit?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `limit_buffer_percentage?`: `number` \| `null`; `rollover_refresh_rate?`: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `authorization_type?`: `"HARD"` \| `"SOFT"` \| `null`; `base_limit?`: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`; `limit_buffer_percentage?`: `number` \| `null`; `rollover_refresh_rate?`: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `null`; \} ###### authorization\_type? > `optional` **authorization\_type?**: `"HARD"` \| `"SOFT"` \| `null` ###### base\_limit? > `optional` **base\_limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### limit\_buffer\_percentage? > `optional` **limit\_buffer\_percentage?**: `number` \| `null` Format: int32 ###### Description The percentage of flexible buffer on the limit as a 0-100 integer. ###### rollover\_refresh\_rate? > `optional` **rollover\_refresh\_rate?**: `"OFF"` \| `"NEVER"` \| `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `null` *** `null` ##### UpdateSpendLimitRequest.authorization\_visibility? > `optional` **authorization\_visibility?**: `"PUBLIC"` \| `"PRIVATE"` \| `null` ##### UpdateSpendLimitRequest.auto\_create\_limit\_cards\_setting? > `optional` **auto\_create\_limit\_cards\_setting?**: `"DISABLED"` \| `"ALL_MEMBERS"` \| `null` ##### UpdateSpendLimitRequest.auto\_transfer\_cards\_setting? > `optional` **auto\_transfer\_cards\_setting?**: `"DISABLED"` \| `"ENABLED"` \| `null` ##### UpdateSpendLimitRequest.department\_id? > `optional` **department\_id?**: `string` \| `null` ###### Description The department ID to which Spend Limit expenses will be attributed. ##### UpdateSpendLimitRequest.description? > `optional` **description?**: `string` \| `null` ###### Description Description of what the Spend Limit is used for. ##### UpdateSpendLimitRequest.end\_date? > `optional` **end\_date?**: `string` \| `null` Format: date ###### Description The date when the Spend Limit should expire. ##### UpdateSpendLimitRequest.expense\_policy\_id? > `optional` **expense\_policy\_id?**: `string` \| `null` ###### Description The ID of the expense policy corresponding to this Spend Limit. ##### UpdateSpendLimitRequest.expense\_visibility? > `optional` **expense\_visibility?**: `"PRIVATE"` \| `"SHARED"` \| `null` ##### UpdateSpendLimitRequest.legal\_entity\_id? > `optional` **legal\_entity\_id?**: `string` \| `null` ###### Description The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user's entity. ##### UpdateSpendLimitRequest.limit\_approval\_policy\_id? > `optional` **limit\_approval\_policy\_id?**: `string` \| `null` ###### Description The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id. ##### UpdateSpendLimitRequest.limit\_increase\_request\_policy\_id? > `optional` **limit\_increase\_request\_policy\_id?**: `string` \| `null` ###### Description The ID of the policy for limit increase requests for this Spend Limit. ##### UpdateSpendLimitRequest.limit\_increase\_setting? > `optional` **limit\_increase\_setting?**: `"DISABLED"` \| `"ENABLED"` \| `null` ##### UpdateSpendLimitRequest.member\_user\_ids? > `optional` **member\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the members of the Spend Limit. ##### UpdateSpendLimitRequest.merchant\_category\_controls? > `optional` **merchant\_category\_controls?**: \{ `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"`)[] \| `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` \| `"GROCERY"` \| `"TELEPHONY"` \| `"OFFICE_SUPPLIES"` \| `"PRIVATE_AIR_TRAVEL"` \| `"CLOTHING"` \| `"CAR_RENTAL"` \| `"VEHICLE_EXPENSES"` \| `"RESTAURANTS"` \| `"GAMBLING"` \| `"FLOWERS"` \| `"ELECTRONICS"` \| `"LEGAL_SERVICES"` \| `"UTILITIES"` \| `"FURNITURE"` \| `"BARS_NIGHTLIFE"` \| `"LAUNDRY"` \| `"EVENT_EXPENSES"` \| `"SHIPPING"` \| `"OTHER_TRAVEL_EXPENSES"` \| `"CHARITY"` \| `"SOFTWARE"` \| `"LODGING"` \| `"FACILITIES_EXPENSES"` \| `"SERVERS"` \| `"CONFERENCES"` \| `"FOOD_DELIVERY"` \| `"RENT"` \| `"AIRLINE_EXPENSES"` \| `"OTHER_BUSINESS_EXPENSES"` \| `"BANK_FINANCIAL_FEES"` \| `"BOOKS_NEWSPAPERS"` \| `"CONSULTANT_CONTRACTOR"` \| `"CORPORATE_INSURANCE"` \| `"DIGITAL_GOODS"` \| `"LICENSES_TAXES"` \| `"GAS_FUEL"` \| `"GENERAL_MERCHANDISE"` \| `"MEDICAL"` \| `"MEMBERSHIPS_CLUBS"` \| `"PARKING_EXPENSES"` \| `"POLITICAL_DONATIONS"` \| `"PUBLIC_TRANSPORTATION"` \| `"RECURRING_SOFTWARE_SAAS"` \| `"RIDESHARE_TAXI"` \| `"TOLL_BRIDGE_FEES"` \| `"TRAINING_EDUCATION"` \| `"TRAVEL"`)[] \| `null`; \} \| `null` ##### UpdateSpendLimitRequest.name? > `optional` **name?**: `string` \| `null` ###### Description Name for the Spend Limit. ##### UpdateSpendLimitRequest.owner\_user\_ids? > `optional` **owner\_user\_ids?**: `string`[] \| `null` ###### Description User IDs of the owners of the Spend Limit. ##### UpdateSpendLimitRequest.period\_recurrence\_type? > `optional` **period\_recurrence\_type?**: `"PER_MONTH"` \| `"PER_QUARTER"` \| `"PER_YEAR"` \| `"ONE_TIME"` \| `"PER_WEEK"` \| `null` ##### UpdateSpendLimitRequest.set\_end\_date\_null? > `optional` **set\_end\_date\_null?**: `boolean` \| `null` ###### Description Set the date when the Spend Limit should expire to null. ##### UpdateSpendLimitRequest.set\_start\_date\_null? > `optional` **set\_start\_date\_null?**: `boolean` \| `null` ###### Description Set the date when the Spend Limit should start counting to null. ##### UpdateSpendLimitRequest.set\_transaction\_limit\_null? > `optional` **set\_transaction\_limit\_null?**: `boolean` \| `null` ###### Description Set the transaction limit that this Spend Limit will enforce to null. ##### UpdateSpendLimitRequest.spend\_type? > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` \| `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` \| `null` ##### UpdateSpendLimitRequest.start\_date? > `optional` **start\_date?**: `string` \| `null` Format: date ###### Description The date when the Spend Limit should start counting. ##### UpdateSpendLimitRequest.status? > `optional` **status?**: `"ACTIVE"` \| `"ARCHIVED"` \| `"DELETED"` \| `"EXPIRED"` \| `null` ##### UpdateSpendLimitRequest.transaction\_limit? > `optional` **transaction\_limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null`