Skip to content

Ramp: Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit

Fetch a spend program: response body, field restrictions / allowed_categories, allowed_vendors, auto_lock_date, blocked_categories, blocked_vendors, interval, limit, next_interval_reset, start_of_interval, temporary_limit, transaction_amount_limit. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Fetch a spend program — response body — restrictions allowed categories, allowed vendors, auto lock date, blocked categories, blocked vendors, interval, limit, next interval reset, start of interval, temporary limit, transaction amount limit

FieldTypePresenceDescription and constraints
$objectRoot
allowed_categoriesarrayRequired within parentList of Ramp category codes allowed for the limit.
allowed_categories[]JSONEach item
allowed_categories[] (anyOf 1)integerAlternativeKnown values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
allowed_categories[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowed_vendorsarrayRequired within parentList of merchants allowed for the limit.
allowed_vendors[]stringEach itemFormat: uuid
auto_lock_dateJSONRequired within parent
auto_lock_date (anyOf 1)stringAlternativeDate to automatically to lock the limit.
Format: date-time
auto_lock_date (anyOf 2)nullAlternative
blocked_categoriesarrayRequired within parentList of Ramp category codes blocked for the limit.
blocked_categories[]JSONEach item
blocked_categories[] (anyOf 1)integerAlternativeKnown values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
blocked_categories[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
blocked_vendorsarrayRequired within parentList of merchants blocked for the limit.
blocked_vendors[]stringEach itemFormat: uuid
intervalstringRequired within parentTime interval the limit is applied on.
Known values: ANNUAL, CUSTOM, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
limitJSONRequired within parent
limit (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount limit total per interval denominated in the smallest currency unit (e.g. cents for USD).
Read only: true
limit (anyOf 2)nullAlternative
next_interval_resetJSONRequired within parent
next_interval_reset (anyOf 1)stringAlternativeDate and time for the next interval reset.
Format: date-time
next_interval_reset (anyOf 2)nullAlternative
start_of_intervalJSONRequired within parent
start_of_interval (anyOf 1)stringAlternativeDate and time for the start of the current interval.
Format: date-time
start_of_interval (anyOf 2)nullAlternative
temporary_limitJSONRequired within parent
temporary_limit (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Temporary limit total per interval.
Read only: true
temporary_limit (anyOf 2)nullAlternative
transaction_amount_limitJSONRequired within parent
transaction_amount_limit (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Max amount allowed on a single transaction.
Read only: true
transaction_amount_limit (anyOf 2)nullAlternative

Referenced models: Hold Bill — 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.