Skip to content

Ramp: Fetch a spend program — response body

Fetch a spend program: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Fetch a spend program — response body

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collectionJSONRequired within parent
custom_form_collection (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — custom form collection custom form collection log entry
Custom form collection for the resource, e.g. form questions required to create a request against a spend program.
Read only: true
custom_form_collection (anyOf 2)nullAlternative
descriptionstringRequired within parentDescription of the spend program.
display_namestringRequired within parentDisplay name of the spend program.
iconstringRequired within parentThe template icon for the spend program.
Known values: AccountingServicesIcon, AdvertisingIcon, CONTRACTORS_AND_PROFESSIONAL_SERVICES, CUSTOM, CardIcon, EducationStipendIcon, EmployeeRewardsIcon, GroundTransportationIcon, LegalFeesIcon, LodgingIcon, LunchOrderingIcon, OnboardingIcon, PerDiemCardIcon, SOFTWARE, SaasSubscriptionIcon, SoftwareTrialIcon, SuppliesIcon, TeamSocialIcon, TravelExpensesIcon, VirtualEventIcon, WellnessIcon, WorkFromHomeIcon, advertising, airlines, bills, business, car_services, contractor, education, entertainment, event_balloons, event_virtual, food, fuel_and_gas, general_expense, general_merchandise, gift, government_services, internet_and_phone, legal, lodging, lodging_room, newspaper, office, physical_card, procurement_checklist, procurement_intake, professional_services, restaurants, reward, saas_software, shipping, travel_misc, wellness
idstringRequired within parentUnique identifier of the spend program.
Format: uuid
is_shareablebooleanRequired within parentWhether this spend program is shareable.
issue_physical_card_if_neededbooleanRequired within parentIndicates whether the spend program should issue a physical card if the user does not have one.
line_item_accounting_fieldsarrayRequired within parentCustom accounting fields enabled for line items in this spend program.
Read only: true
line_item_accounting_fields[]ModelEach itemExpand Fetch a spend program — response body — line item accounting fields item
line_item_custom_fieldsarrayRequired within parentCustom fields enabled for line items in this spend program.
Read only: true
line_item_custom_fields[]ModelEach itemExpand Fetch a spend program — response body — line item custom fields item
permitted_spend_typesJSONRequired within parent
permitted_spend_types (anyOf 1)ModelAlternativeExpand Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled
Permitted spend types for the spend program.
permitted_spend_types (anyOf 2)nullAlternative
restrictionsJSONRequired within parent
restrictions (anyOf 1)ModelAlternativeExpand 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
A set of restrictions imposed on the spend program.
Read only: true
restrictions (anyOf 2)nullAlternative

Referenced models: Fetch a spend program — response body — permitted spend types primary card enabled, reimbursements enabled, Fetch a spend program — response body — custom form collection custom form collection log entry, Fetch a spend program — response body — line item accounting fields item, Fetch a spend program — response body — line item custom fields item, 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

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.