v1
latestSwagger 2.02026-08-04283399898.4 KBbookings
Read one booking
get/bookings/{id}
Path parameters
idinteger required
Response
HTTP status code 200 and rental model
abandonedboolean
adultsinteger
affirm_totalinteger
Dynamically calculated. Not stored in DB
applicable_tos_versionstring
auto_assign_groupboolean nullable
auto_insurance_typestring
bid_idinteger
block_discount_codeboolean
bookedstring
Not Mutable
booking_agentstring
booking_colorstring nullable
booking_tokenstring
bundle_idstring
calculated field that holds the result of whether the rental has this assigned if not, will look at the user/owner
calculated_day_priceinteger
calculated_total_paidinteger
campaignstring
dealer only
campground_booking_urlstring
Contains the booking id so ember can call /bookings/:id/default-selections
can_add_ending_generator_valuesboolean
can_add_ending_mileage_valuesboolean
can_add_starting_generator_valuesboolean
can_add_starting_mileage_valuesboolean
can_add_trip_protectionboolean
CanAddTransaction is used to check if the guest can add a trip protection
can_apply_creditsboolean
can_cancel_trip_protectionboolean
CanCancelTripProtection is used to check if the guest can cancel a trip protection
can_charge_overage_feesboolean
can_file_claimboolean
can_generate_weather_quoteboolean
can_manage_security_depositboolean
can_manage_tax_ratesboolean
used by dashboard to disable tax editing
can_renter_reviewboolean
can_renter_review_untilstring
can_see_contractboolean
can_suggest_date_changeboolean
can_suggest_delivery_changeboolean
cancel_metadataCancelMetadata
CancelMetadata is stored as JSONB and contains structured cancellation information for analytics and tracking Fields: reason_value, penalty_category, timestamp, reason_metadata
cancel_policystring
cancel_reasonstring
canceledstring
cancellation_cutoff_datestring
cancellation_refund_percentagenumber double
cc_fee_percentagenumber double
Copied rental data - don't want rental changes to affect this booking
checkin_stampstring
Internal
checkout_questionsobject[]
DBMSISlice is a []string with database conversion methods
checkout_stampstring
checkout_steps_idinteger
childreninteger
coachnet_idinteger
coachnet_premiuminteger
conversation_idinteger
createdstring
created_by_idinteger
created_stampstring
custom_insurance_textstring nullable
dealer_minimum_daysinteger
used to display information if a booking is below the dealers minimum days
decline_reasonstring
default_insurance_coveragestring
{"stackTrail":"components:schemas:Booking:properties:delivery_usage_item","oasType":"schema","type":"unknown","extensionFields":{"x-go-name":"DeliveryUsageItemJSON"}}
delivery_usage_item_idinteger
deposit_percentagenumber double
destinationstring
destination_latnumber double
destination_lngnumber double
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
device_idstring
discount_codestring
Copied discount code data, not allowed in request data.
discount_code_amountinteger
discount_code_applied_tostring
discount_code_messagestring
display_insurancestring
display_sourcestring
display_statusstring
display_status_stylestring
durationinteger
esign_enabledboolean
esign_pendingboolean
expire_reasonstring
express_checkout_idinteger
externalboolean nullable
fees_lockedboolean
fees_totalinteger
final_payment_due_daysinteger
followup_archivedboolean
formatted_total_overage_feestring
fraudulentboolean
free_cancellation_availableboolean
free_cancellation_periodinteger
fromstring
from_timeinteger
fx_fee_paidinteger
{"stackTrail":"components:schemas:Booking:properties:generator_usage_item","oasType":"schema","type":"unknown","extensionFields":{"x-go-name":"GeneratorUsageItemJSON"}}
generator_usage_item_idinteger
grace_period_ends_atstring
has_approved_driversboolean
has_setup_intent_enabledboolean
hold_sales_taxboolean
house_rulesstring
idinteger
import_idstring
importedboolean
owner only
include_coachnetboolean
infantsinteger
initial_durationinteger
instamatchboolean nullable
instant_bookboolean
insurancestring
insurance_approvedboolean
insurance_approved_timestampstring
insurance_approved_updated_timestampstring
{"stackTrail":"components:schemas:Booking:properties:insurance_bundle","oasType":"schema","type":"unknown","description":"Using an interface{} to avoid import cycle and from having to move structs into the models package.","extensionFields":{"x-go-name":"BookingBundle"}}
insurance_claim_filedboolean
insurance_coveragestring
insurance_renter_adjustableboolean
internal_notesstring
is_request_less_than_minimum_daysboolean
is_within_grace_periodboolean
location_idinteger
lockedboolean
loyalty_credit_issuedboolean
loyalty_rewards_eligibleboolean
mediumstring
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
{"stackTrail":"components:schemas:Booking:properties:mileage_usage_item","oasType":"schema","type":"unknown","extensionFields":{"x-go-name":"MileageUsageItemJSON"}}
mileage_usage_item_idinteger
minimum_depositinteger
missing_datastring[]
missing_requirementsobject
mutual_cancellationboolean
non_refundable_totalinteger
NonRefundableTotal is the total amount that cannot be refunded to the renter. Trip Insurance that has been started is an example of something that would be added to this total
offer_affirmboolean
offer_insuranceboolean
offer_paypal_pay_laterboolean
offer_roadsideboolean
original_booking_sourcestring
original_day_priceinteger
original_security_depositinteger
original_security_deposit_v2integer
original_service_feeinteger
renter only
outdoorsy_feeinteger
outdoorsy_remitted_taxesinteger
overage_fee_collectedboolean
overage_fee_expiredboolean
overage_fee_section_displayboolean
owner_addon_totalinteger
Sum of all addons (booking items from rental_item parent_item_type)
owner_approval_attemptedboolean nullable
owner_approvedboolean
owner_approved_atstring
owner_archivedboolean
owner_credits_appliedinteger
owner_did_reviewboolean
owner_feeinteger
owner_fee_aggregate_percentagenumber double
aggregate percentage for all owner fee services that we apply - for UI purpouses
owner_fee_minimum_enforcedboolean
Owner fee minimum enforced
owner_fee_minimum_per_nightinteger
Owner fee minimum per night
owner_fee_on_renter_cancellationinteger
Cancellation payout details - populated for owner/admin when status is renter_cancelled Enables the host dashboard cancellation payout breakdown modal (MP-4959)
owner_fee_percentagenumber double
owner_fee_percentage_recordnumber double
owner_idinteger
owner_insurance_claim_filedboolean
owner_insurance_fee_totalinteger
owner_integrations_feeinteger nullable
owner_payoutinteger
owner_payout_adjustmentinteger
owner_payout_with_claim_adjustmentsinteger
OwnerPayout + Claim adjustments if any
owner_readboolean
{"stackTrail":"components:schemas:Booking:properties:owner_summary","oasType":"schema","type":"unknown","extensionFields":{"x-go-name":"OwnerSummary"}}
owner_totalinteger
owner_total_without_taxinteger
OwnerTotal - Tax (subtotal)
parent_booking_idinteger nullable
payout_actual_transfer_amountinteger
booking transfers summary
personal_insurance_verificationboolean
personal_insurance_verification_statusstring
petsinteger
premium_totalinteger
presentment_currencystring
processor_namestring
provide_insurance_binderboolean
reasonstring nullable
referred_owner_paidboolean
referred_owner_payout_amountinteger
referred_renter_paidboolean
referred_renter_payout_amountinteger
remainder_amountinteger
remainder_due_datestring
remaining_days_to_cancellation_cutoffinteger
rental_charge_card_idinteger
rental_idinteger
{"stackTrail":"components:schemas:Booking:properties:rental_summary","oasType":"schema","type":"unknown","description":"partial objects","extensionFields":{"x-go-name":"RentalSummary"}}
renter_ageinteger
renter_approvedboolean
renter_approved_atstring
renter_archivedboolean
renter_can_waive_insuranceboolean
renter_credits_appliedinteger
renter_did_reviewboolean
renter_fee_percentagenumber double
renter_fee_percentage_recordnumber double
renter_idinteger
renter_insurance_claim_filedboolean
renter_insurance_fee_totalinteger
renter_readboolean
{"stackTrail":"components:schemas:Booking:properties:renter_summary","oasType":"schema","type":"unknown","extensionFields":{"x-go-name":"RenterSummary"}}
require_booking_timeboolean
require_dmv_checkboolean
require_driversboolean
require_insuranceboolean
require_renter_id_verificationboolean
require_roadsideboolean
reserve_amountinteger
reserve_amount_after_creditsinteger
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
sd_post_trip_charges_enabledboolean
security_depositinteger
security_deposit_card_idinteger
security_deposit_claimed_amountinteger
security_deposit_due_datestring
security_deposit_due_daysinteger
security_deposit_payout_amountinteger
security_deposit_refund_amountinteger
security_deposit_remaininginteger
security_deposit_reversableinteger
security_deposit_statusstring
service_feeinteger
session_idstring
sibling_booking_group_idinteger nullable
sourcestring
special_insurance_caseboolean
stagestring
statusstring
subtotalinteger
subtotal_with_claim_adjustmentsinteger
Booking subtotal with claim adjustments
support_statusstring
system_generatedboolean
taxinteger
tiered_owner_fee_percentagenumber double
tiered_renter_fee_percentagenumber double
time_to_first_actioninteger
tostring
to_timeinteger
tollspot_monitor_idinteger
totalinteger
total_after_creditsinteger
total_after_deductionsinteger
the total amount that we will take from user card/paypal account for a given booking deprecated use TotalAfterCredits
total_cc_feesinteger
total_overage_fee_amountinteger
total_owner_federal_withholding_taxinteger
total_owner_quebec_sales_taxinteger
total_paidinteger
total_paid_with_claim_adjustmentsinteger
For admin portal current rental paid = booking total_paind + claim adjustments
total_security_deposit_cc_feesinteger
total_with_claim_adjustmentsinteger
For renter payment detals = total_after_credits (or booking total if not present) + claim adjustments
travel_to_statesstring[]
traveler_typestring
travelersinteger
trip_credits_disabledboolean
unclaimed_feesinteger
undelivered_emails_countinteger
update_warningsstring[]
updatedstring
updated_stampstring
use_custom_tax_ratesboolean
use_day_pricingboolean
use_fees_increaseboolean nullable
use_insurance_bundlesboolean
use_system_tax_ratesboolean
used by booking details page to display system tax notice
use_tax_inclusive_pricingboolean
use_tint_checkboolean
user_rolestring
waived_insurance_textstring nullable