Skip to content

Ramp: Business schemas

2 Ramp schemas with complete fields and constraints.

← Business operations · All schemas

Fetch the company balance information — response body

FieldTypePresenceDescription and constraints
$objectRoot
available_card_limitJSONOptional
available_card_limit (anyOf 1)numberAlternativeRemaining available card spending limit.
available_card_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
available_card_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Remaining available card spending limit in minor units with an explicit USD currency code.
Read only: true
available_flex_limitJSONOptional
available_flex_limit (anyOf 1)numberAlternativeRemaining available flex spending limit.
available_flex_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
available_flex_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Remaining available flex spending limit in minor units with an explicit USD currency code.
Read only: true
balance_including_pendingJSONOptional
balance_including_pending (anyOf 1)numberAlternativeTotal balance including pending transactions.
balance_including_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_including_pending_amountModelRequired within parentExpand 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_amountModelRequired within parentExpand 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_pendingJSONOptional
card_balance_including_pending (anyOf 1)numberAlternativeCurrent card balance including pending transactions.
card_balance_including_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
card_balance_including_pending_amountModelRequired within parentExpand Hold Bill — response body — amount
Current card balance including pending transactions in minor units with an explicit USD currency code.
Read only: true
card_limitJSONOptional
card_limit (anyOf 1)numberAlternativeMaximum allowed card spending limit.
card_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
card_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Maximum allowed card spending limit in minor units with an explicit USD currency code.
Read only: true
flex_balanceJSONOptional
flex_balance (anyOf 1)numberAlternativeCurrent balance of flex spending.
flex_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
flex_balance_amountModelRequired within parentExpand Hold Bill — response body — amount
Current balance of flex spending in minor units with an explicit USD currency code.
Read only: true
flex_limitJSONOptional
flex_limit (anyOf 1)numberAlternativeMaximum allowed flex spending limit.
flex_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
flex_limit_amountModelRequired within parentExpand 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_pendingJSONOptional
float_balance_excluding_pending (anyOf 1)numberAlternativeFloat account balance excluding pending transactions.
float_balance_excluding_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
float_balance_excluding_pending_amountModelRequired within parentExpand Hold Bill — response body — amount
Float account balance excluding pending transactions in minor units with an explicit USD currency code.
Read only: true
global_limitJSONOptional
global_limit (anyOf 1)numberAlternativeOverall spending limit for the business.
global_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
global_limit_amountModelRequired within parentExpand Hold Bill — response body — amount
Overall spending limit for the business in minor units with an explicit USD currency code.
Read only: true
max_balanceJSONOptional
max_balance (anyOf 1)numberAlternativeMaximum balance allowed for the business.
max_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_balance_amountModelRequired within parentExpand 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_datestringOptionalDate of the next billing cycle.
prev_billing_datestringOptionalDate of the previous billing cycle.
statement_balanceJSONOptional
statement_balance (anyOf 1)numberAlternativeBalance from the most recent statement.
statement_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statement_balance_amountModelRequired within parentExpand 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

Fetch the company information — response body

FieldTypePresenceDescription and constraints
$objectRoot
activebooleanOptionalWhether the business account is active.
billing_addressobjectOptionalBilling address of the business.
business_name_legalstringOptionalLegal name of the business entity.
business_name_on_cardstringOptionalBusiness name that appears on issued cards.
created_timestringOptionalWhen the business account was created.
Format: date-time
enforce_ssobooleanOptionalWhether single sign-on is enforced for the business.
idstringOptionalUnique identifier for the business.
Format: uuid
initial_approved_limitJSONOptional
initial_approved_limit (anyOf 1)integerAlternativeInitial credit limit approved for the business, in whole US dollars (USD).
initial_approved_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
initial_approved_limit_amountJSONRequired within parent
initial_approved_limit_amount (anyOf 1)ModelAlternativeExpand Fetch a payment — response body — amount
Initial credit limit approved for the business, in minor units (cents) with an explicit USD currency code. `null` if no initial limit has been approved.
Read only: true
initial_approved_limit_amount (anyOf 2)nullAlternative
is_integrated_with_slackbooleanOptionalWhether the business has integrated with Slack.
is_reimbursements_enabledbooleanRequired within parentWhether reimbursements feature is enabled for the business.
limit_lockedbooleanOptionalWhether the credit limit is locked and cannot be modified.
phonestringOptionalPrimary contact phone number for the business.
websitestringOptionalCompany website URL.

Referenced models: Fetch a payment — response body — amount

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.