Ramp: Fetch the company balance information — response body
Fetch the company balance information: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Fetch the company balance information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available_card_limit | JSON | Optional | |
available_card_limit (anyOf 1) | number | Alternative | Remaining available card spending limit. |
available_card_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
available_card_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Remaining available card spending limit in minor units with an explicit USD currency code. Read only: true |
available_flex_limit | JSON | Optional | |
available_flex_limit (anyOf 1) | number | Alternative | Remaining available flex spending limit. |
available_flex_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
available_flex_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Remaining available flex spending limit in minor units with an explicit USD currency code. Read only: true |
balance_including_pending | JSON | Optional | |
balance_including_pending (anyOf 1) | number | Alternative | Total balance including pending transactions. |
balance_including_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_including_pending_amount | Model | Required within parent | Expand Hold Bill — response body — amount Total balance including pending transactions in minor units with an explicit USD currency code. Read only: true |
card_balance_excluding_pending_amount | Model | Required within parent | Expand Hold Bill — response body — amount Current card balance excluding pending transactions in minor units with an explicit USD currency code. Read only: true |
card_balance_including_pending | JSON | Optional | |
card_balance_including_pending (anyOf 1) | number | Alternative | Current card balance including pending transactions. |
card_balance_including_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
card_balance_including_pending_amount | Model | Required within parent | Expand Hold Bill — response body — amount Current card balance including pending transactions in minor units with an explicit USD currency code. Read only: true |
card_limit | JSON | Optional | |
card_limit (anyOf 1) | number | Alternative | Maximum allowed card spending limit. |
card_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
card_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Maximum allowed card spending limit in minor units with an explicit USD currency code. Read only: true |
flex_balance | JSON | Optional | |
flex_balance (anyOf 1) | number | Alternative | Current balance of flex spending. |
flex_balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
flex_balance_amount | Model | Required within parent | Expand Hold Bill — response body — amount Current balance of flex spending in minor units with an explicit USD currency code. Read only: true |
flex_limit | JSON | Optional | |
flex_limit (anyOf 1) | number | Alternative | Maximum allowed flex spending limit. |
flex_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
flex_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Maximum allowed flex spending limit in minor units with an explicit USD currency code. Read only: true |
float_balance_excluding_pending | JSON | Optional | |
float_balance_excluding_pending (anyOf 1) | number | Alternative | Float account balance excluding pending transactions. |
float_balance_excluding_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
float_balance_excluding_pending_amount | Model | Required within parent | Expand Hold Bill — response body — amount Float account balance excluding pending transactions in minor units with an explicit USD currency code. Read only: true |
global_limit | JSON | Optional | |
global_limit (anyOf 1) | number | Alternative | Overall spending limit for the business. |
global_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
global_limit_amount | Model | Required within parent | Expand Hold Bill — response body — amount Overall spending limit for the business in minor units with an explicit USD currency code. Read only: true |
max_balance | JSON | Optional | |
max_balance (anyOf 1) | number | Alternative | Maximum balance allowed for the business. |
max_balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_balance_amount | Model | Required within parent | Expand Hold Bill — response body — amount Maximum balance allowed for the business in minor units with an explicit USD currency code. Read only: true |
next_billing_date | string | Optional | Date of the next billing cycle. |
prev_billing_date | string | Optional | Date of the previous billing cycle. |
statement_balance | JSON | Optional | |
statement_balance (anyOf 1) | number | Alternative | Balance from the most recent statement. |
statement_balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
statement_balance_amount | Model | Required within parent | Expand Hold Bill — response body — amount Balance from the most recent statement in minor units with an explicit USD currency code. Read only: true |
Referenced models: Hold Bill — response body — amount