Brex: Budgets schemas
15 Brex schemas with complete fields and constraints.
← Budgets operations · All schemas
Get Budget Program — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Budget Program used to create Spend Limits for eligible users. |
budget_blueprints | array | Required within parent | |
budget_blueprints[] | Model | Each item | Expand Get Budget Program — response body — budget blueprints item |
budget_program_status | string | Required within parent | Known values: BUDGET_PROGRAM_STATUS_ACTIVE, BUDGET_PROGRAM_STATUS_INACTIVE, BUDGET_PROGRAM_STATUS_DELETED |
created_at | string | Required within parent | Format: date |
creator_user_id | JSON | Optional | |
creator_user_id (anyOf 1) | string | Alternative | |
creator_user_id (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
employee_filter | JSON | Optional | |
employee_filter (anyOf 1) | JSON | Alternative | |
employee_filter (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Budget Program — response body — employee filter employment status, employment type employment status, employment type |
employee_filter (anyOf 2) | null | Alternative | |
existing_budget_ids | JSON | Optional | |
existing_budget_ids (anyOf 1) | array | Alternative | IDs for existing Spend Limits associated with this Budget Program. |
existing_budget_ids (anyOf 1)[] | string | Each item | |
existing_budget_ids (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | string | Required within parent | |
updated_at | string | Required within parent | Format: date |
Referenced models: Get Budget Program — response body — budget blueprints item, Get Budget Program — response body — employee filter employment status, employment type employment status, employment type
Get Budget Program — response body — budget blueprints item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blueprint for provisioning Spend Limits for a Budget Program. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of what the Spend Limit is used for. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The UTC date when the Spend Limit should stop counting. Format: date |
end_date (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
limit | JSON | Optional | |
limit (anyOf 1) | JSON | Alternative | |
limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
limit (anyOf 2) | null | Alternative | |
limit_type | string | Required within parent | Whether the Spend Limit's limit blocks spend. Known values: HARD, SOFT |
limit_visibility | string | Required within parent | Determines if Spend Limit members are allowed to view the Spend Limit's limit. Known values: SHARED, PRIVATE |
name | string | Required within parent | Name for the Spend Limit. |
owner_user_ids | array | Required within parent | User IDs of the owners of the Spend Limit. |
owner_user_ids[] | string | Each item | |
parent_budget_id | string | Required within parent | ID of parent Budget. |
period_type | string | Required within parent | Period type of the Spend Limit e.g. MONTHLY. Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
spend_type | string | Required within parent | Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. Known values: BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The UTC date when the Spend Limit should start counting. Format: date |
start_date (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
Get Budget Program — response body — employee filter employment status, employment type employment status, employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A filter used to determine if a user adheres to a Budget Program. |
employment_status | JSON | Optional | |
employment_status (anyOf 1) | JSON | Alternative | |
employment_status (anyOf 1) (allOf 1) | string | All variants apply | A filter used to determine if a user adheres to a Budget Program. Known values: EMPLOYMENT_STATUS_ACTIVE, EMPLOYMENT_STATUS_INACTIVE, EMPLOYMENT_STATUS_PENDING |
employment_status (anyOf 2) | null | Alternative | |
employment_type | JSON | Optional | |
employment_type (anyOf 1) | JSON | Alternative | |
employment_type (anyOf 1) (allOf 1) | string | All variants apply | What kind of employment the employee has. Known values: EMPLOYMENT_TYPE_FULL_TIME, EMPLOYMENT_TYPE_PART_TIME, EMPLOYMENT_TYPE_CONTRACTOR, EMPLOYMENT_TYPE_INTERN, EMPLOYMENT_TYPE_FREELANCE |
employment_type (anyOf 2) | null | Alternative |
Get Budget — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Required within parent | The Brex account this Budget belongs to. |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
amount (anyOf 2) | null | Alternative | |
budget_id | string | Required within parent | Unique ID for the Budget. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of what the Budget is used for. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The date when the Budget should stop counting. Format: date |
end_date (anyOf 2) | null | Alternative | |
limit_type | JSON | Optional | |
limit_type (anyOf 1) | JSON | Alternative | |
limit_type (anyOf 1) (allOf 1) | string | All variants apply | Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. Known values: HARD, SOFT |
limit_type (anyOf 1) (allOf 2) | JSON | All variants apply | Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. |
limit_type (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name for the Budget. |
owner_user_ids | array | Required within parent | User IDs of the owners of the Budget. |
owner_user_ids[] | string | Each item | |
parent_budget_id | JSON | Optional | |
parent_budget_id (anyOf 1) | string | Alternative | ID of parent Budget. |
parent_budget_id (anyOf 2) | null | Alternative | |
period_recurrence_type | JSON | Required within parent | |
period_recurrence_type (allOf 1) | string | All variants apply | Period type of the Budget e.g. MONTHLY. Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
period_recurrence_type (allOf 2) | JSON | All variants apply | Period type of the Budget e.g. MONTHLY. |
spend_budget_status | JSON | Required within parent | |
spend_budget_status (allOf 1) | string | All variants apply | Status of the Budget e.g. ACTIVE. Known values: ACTIVE, ARCHIVED, DELETED, EXPIRED |
spend_budget_status (allOf 2) | JSON | All variants apply | Status of the Budget e.g. ACTIVE. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date when the Budget should start counting. Format: date |
start_date (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
Get Spend Limit — budgets budgets Get Budget By Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Required within parent | The Brex account this Spend Limit belongs to. |
budget_id | string | Required within parent | Unique ID for the Spend Limit. |
budget_status | string | Required within parent | Status of the Spend Limit e.g. APPROVED. Known values: APPROVED, EXPIRED, TERMINATED, DELETED |
budget_type | JSON | Required within parent | |
budget_type (allOf 1) | string | All variants apply | Whether this is a Budget or a Spend Limit for post-bifurcation entities. Known values: BUDGET, SPEND_LIMIT |
budget_type (allOf 2) | JSON | All variants apply | Whether this is a Budget or a Spend Limit for post-bifurcation entities. |
creator_user_id | JSON | Optional | |
creator_user_id (anyOf 1) | string | Alternative | The ID of the user who originally created this Spend Limit. |
creator_user_id (anyOf 2) | null | Alternative | |
current_period_balance | JSON | Optional | |
current_period_balance (anyOf 1) | JSON | Alternative | |
current_period_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Spend Limit — budgets budgets Get Budget By Id — response body — current period balance balance, end date, start date balance, end date, start date |
current_period_balance (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of what the Spend Limit is used for. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The UTC date when the Spend Limit should stop counting. Format: date |
end_date (anyOf 2) | null | Alternative | |
limit | JSON | Optional | |
limit (anyOf 1) | JSON | Alternative | |
limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
limit (anyOf 2) | null | Alternative | |
limit_type | JSON | Optional | |
limit_type (anyOf 1) | JSON | Alternative | |
limit_type (anyOf 1) (allOf 1) | string | All variants apply | Whether the Spend Limit's limit blocks spend. Known values: HARD, SOFT |
limit_type (anyOf 2) | null | Alternative | |
limit_visibility | JSON | Required within parent | |
limit_visibility (allOf 1) | string | All variants apply | Determines if Spend Limit members are allowed to view the Spend Limit's limit. Known values: SHARED, PRIVATE |
limit_visibility (allOf 2) | JSON | All variants apply | Determines if Spend Limit members are allowed to view the Spend Limit's limit. |
member_user_ids | array | Required within parent | User IDs of the members of the Spend Limit. |
member_user_ids[] | string | Each item | |
name | string | Required within parent | Name for the Spend Limit. |
owner_user_ids | array | Required within parent | User IDs of the owners of the Spend Limit. |
owner_user_ids[] | string | Each item | |
parent_budget_id | JSON | Optional | |
parent_budget_id (anyOf 1) | string | Alternative | ID of parent Budget. |
parent_budget_id (anyOf 2) | null | Alternative | |
period_type | string | Required within parent | Period type of the Spend Limit e.g. MONTHLY. Known values: WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
spend_type | string | Required within parent | Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. Known values: BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The UTC date when the Spend Limit should start counting. Format: date |
start_date (anyOf 2) | null | Alternative | |
templateId | JSON | Optional | |
templateId (anyOf 1) | string | Alternative | |
templateId (anyOf 2) | null | Alternative |
Referenced models: Get Spend Limit — budgets budgets Get Budget By Id — response body — current period balance balance, end date, start date balance, end date, start date, Get transfer — response body — amount
Get Spend Limit — budgets budgets Get Budget By Id — response body — current period balance balance, end date, start date balance, end date, start date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current Spend Limit period balance. |
balance | JSON | Optional | |
balance (anyOf 1) | JSON | Alternative | |
balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
balance (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Format: date |
end_date (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Format: date |
start_date (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
Get Spend Limit — budgets budgets Get Spend Limit By Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Required within parent | The Brex account this Spend Limit belongs to. |
authorization_settings | JSON | Optional | |
authorization_settings (anyOf 1) | JSON | Alternative | |
authorization_settings (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — authorization settings authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate |
authorization_settings (anyOf 1) (allOf 2) | JSON | All variants apply | Spend authorization settings. |
authorization_settings (anyOf 2) | null | Alternative | |
authorization_visibility | JSON | Required within parent | |
authorization_visibility (allOf 1) | string | All variants apply | Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral). Known values: PUBLIC, PRIVATE |
authorization_visibility (allOf 2) | JSON | All variants apply | Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral). |
auto_create_limit_cards_setting | JSON | Required within parent | |
auto_create_limit_cards_setting (allOf 1) | string | All variants apply | Setting for how auto limit card creation works for members. Known values: DISABLED, ALL_MEMBERS |
auto_create_limit_cards_setting (allOf 2) | JSON | All variants apply | Setting for how auto limit card creation works for members. |
auto_transfer_cards_setting | JSON | Required within parent | |
auto_transfer_cards_setting (allOf 1) | string | All variants apply | Setting for how auto transfer works for virtual cards. Known values: DISABLED, ENABLED |
auto_transfer_cards_setting (allOf 2) | JSON | All variants apply | Setting for how auto transfer works for virtual cards. |
current_period_balance | JSON | Optional | |
current_period_balance (anyOf 1) | JSON | Alternative | |
current_period_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — current period balance amount spent, end date, end time, rollover amount, start date, start time amount spent, end date, end time, rollover amount, start date, start time |
current_period_balance (anyOf 2) | null | Alternative | |
department_id | JSON | Optional | |
department_id (anyOf 1) | string | Alternative | The department ID to which Spend Limit expenses will be attributed. |
department_id (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of what the Spend Limit is used for. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The date when the Spend Limit should expire. Format: date |
end_date (anyOf 2) | null | Alternative | |
end_time_utc | JSON | Optional | |
end_time_utc (anyOf 1) | string | Alternative | The UTC time when the Spend Limit should expire. Format: date-time |
end_time_utc (anyOf 2) | null | Alternative | |
expense_policy_id | string | Required within parent | The ID of the expense policy corresponding to this Spend Limit. |
expense_visibility | JSON | Required within parent | |
expense_visibility (allOf 1) | string | All variants apply | Whether or not expense related to this Spend Limit should be viewable to all members. Known values: SHARED, PRIVATE |
expense_visibility (allOf 2) | JSON | All variants apply | Whether or not expense related to this Spend Limit should be viewable to all members. |
id | string | Required within parent | Unique ID for the Spend Limit. |
legal_entity_id | JSON | Optional | |
legal_entity_id (anyOf 1) | string | Alternative | 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. |
legal_entity_id (anyOf 2) | null | Alternative | |
limit_approval_policy_id | JSON | Optional | |
limit_approval_policy_id (anyOf 1) | string | Alternative | The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id. |
limit_approval_policy_id (anyOf 2) | null | Alternative | |
limit_increase_request_policy_id | JSON | Optional | |
limit_increase_request_policy_id (anyOf 1) | string | Alternative | The ID of the policy for limit increase requests for this Spend Limit. |
limit_increase_request_policy_id (anyOf 2) | null | Alternative | |
limit_increase_setting | JSON | Required within parent | |
limit_increase_setting (allOf 1) | string | All variants apply | Whether or not members can request limit increases. Known values: ENABLED, DISABLED |
limit_increase_setting (allOf 2) | JSON | All variants apply | Whether or not members can request limit increases. |
member_user_ids | array | Required within parent | User IDs of the members of the Spend Limit. |
member_user_ids[] | string | Each item | |
merchant_category_controls | JSON | Optional | |
merchant_category_controls (anyOf 1) | JSON | Alternative | |
merchant_category_controls (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories |
merchant_category_controls (anyOf 1) (allOf 2) | JSON | All variants apply | The Spend Limit's merchant category controls. |
merchant_category_controls (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name for the Spend Limit. |
owner_user_ids | array | Required within parent | User IDs of the owners of the Spend Limit. |
owner_user_ids[] | string | Each item | |
parent_budget_id | JSON | Optional | |
parent_budget_id (anyOf 1) | string | Alternative | ID of parent Budget. |
parent_budget_id (anyOf 2) | null | Alternative | |
period_recurrence_type | JSON | Required within parent | |
period_recurrence_type (allOf 1) | string | All variants apply | Period type of the Spend Limit e.g. MONTHLY. Known values: PER_WEEK, PER_MONTH, PER_QUARTER, PER_YEAR, ONE_TIME |
period_recurrence_type (allOf 2) | JSON | All variants apply | Period type of the Spend Limit e.g. MONTHLY. |
spend_type | JSON | Required within parent | |
spend_type (allOf 1) | string | All variants apply | Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. Known values: BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED |
spend_type (allOf 2) | JSON | All variants apply | Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date when the Spend Limit should start counting. Format: date |
start_date (anyOf 2) | null | Alternative | |
start_time_utc | JSON | Optional | |
start_time_utc (anyOf 1) | string | Alternative | The UTC time when the Spend Limit should start counting. Format: date-time |
start_time_utc (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Status of the Spend Limit e.g. ACTIVE. Known values: ACTIVE, EXPIRED, ARCHIVED, DELETED |
status (allOf 2) | JSON | All variants apply | Status of the Spend Limit e.g. ACTIVE. |
transaction_limit | JSON | Optional | |
transaction_limit (anyOf 1) | JSON | Alternative | |
transaction_limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
transaction_limit (anyOf 1) (allOf 2) | JSON | All variants apply | The transaction limit that this Spend Limit will enforce. |
transaction_limit (anyOf 2) | null | Alternative |
Referenced models: Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — authorization settings authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate, Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories, Get transfer — response body — amount, Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — current period balance amount spent, end date, end time, rollover amount, start date, start time amount spent, end date, end time, rollover amount, start date, start time
Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — authorization settings authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate authorization type, base limit, limit buffer percentage, limit with increases, rollover refresh rate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authorization_type | JSON | Required within parent | |
authorization_type (allOf 1) | string | All variants apply | Whether authorizations will decline based on available balance. Known values: HARD, SOFT |
authorization_type (allOf 2) | JSON | All variants apply | Whether authorizations will decline based on available balance. |
base_limit | JSON | Required within parent | |
base_limit (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
base_limit (allOf 2) | JSON | All variants apply | Base input limit of the Spend Limit, without limit increases/rollovers/etc. |
limit_buffer_percentage | JSON | Optional | |
limit_buffer_percentage (anyOf 1) | JSON | Alternative | |
limit_buffer_percentage (anyOf 1) (anyOf 1) | integer | Alternative | The percentage of flexible buffer on the limit as a 0-100 integer. Format: int32 |
limit_buffer_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
limit_buffer_percentage (anyOf 2) | null | Alternative | |
limit_with_increases | JSON | Required within parent | |
limit_with_increases (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
limit_with_increases (allOf 2) | JSON | All variants apply | The current adjusted limit of the spend limit (base limit + active limit increases). |
rollover_refresh_rate | JSON | Required within parent | |
rollover_refresh_rate (allOf 1) | string | All variants apply | 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). Known values: OFF, NEVER, PER_MONTH, PER_QUARTER, PER_YEAR |
rollover_refresh_rate (allOf 2) | JSON | All variants apply | 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). |
Referenced models: Get transfer — response body — amount
Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — current period balance amount spent, end date, end time, rollover amount, start date, start time amount spent, end date, end time, rollover amount, start date, start time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_spent | JSON | Optional | |
amount_spent (anyOf 1) | JSON | Alternative | |
amount_spent (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
amount_spent (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Format: date |
end_date (anyOf 2) | null | Alternative | |
end_time | JSON | Optional | |
end_time (anyOf 1) | string | Alternative | Format: date-time |
end_time (anyOf 2) | null | Alternative | |
rollover_amount | JSON | Optional | |
rollover_amount (anyOf 1) | JSON | Alternative | |
rollover_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
rollover_amount (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Format: date |
start_date (anyOf 2) | null | Alternative | |
start_time | JSON | Optional | |
start_time (anyOf 1) | string | Alternative | Format: date-time |
start_time (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_merchant_categories | JSON | Optional | |
allowed_merchant_categories (anyOf 1) | array | Alternative | |
allowed_merchant_categories (anyOf 1)[] | Model | Each item | Expand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories allowed merchant categories array item |
allowed_merchant_categories (anyOf 2) | null | Alternative | |
blocked_merchant_categories | JSON | Optional | |
blocked_merchant_categories (anyOf 1) | array | Alternative | |
blocked_merchant_categories (anyOf 1)[] | Model | Each item | Expand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories allowed merchant categories array item |
blocked_merchant_categories (anyOf 2) | null | Alternative |
Get Spend Limit — budgets budgets Get Spend Limit By Id — response body — merchant category controls allowed merchant categories, blocked merchant categories allowed merchant categories, blocked merchant categories allowed merchant categories array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known values: 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 |
List Budget Programs — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Budget Program — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Budget Program — response body
List Budgets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Budget — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Budget — response body
List Spend Limits — budgets budgets List Budgets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Spend Limit — budgets budgets Get Budget By Id — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Spend Limit — budgets budgets Get Budget By Id — response body
List Spend Limits — budgets budgets List Spend Limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Spend Limit — budgets budgets Get Spend Limit By Id — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Spend Limit — budgets budgets Get Spend Limit By Id — response body