Vrbo on Rapid integration guide

A guide to the Vrbo integration process for partners.

Overview

This article offers a guide to the Rapid Vrbo integration process including how it works, example API requests and responses, limitations, error handling, and FAQs.

This guide is geared toward our recommended Vrbo supply offering. For advanced use cases please see the advanced integration guide below.

|

Geography

Need to know

  • Partners using Rapid Geography who are enabled for Vrbo can also access Vrbo property IDs from all Geography APIs alongside conventional lodging properties.

Key topic: Mapping

  • Please note that we are unable to expose property street addresses until a booking has been made.
  • Partners should use the lat/long from the Content API in conjunction with your own geography solution to map properties.
  • Properties where the property has requested privacy should use the obfuscated lat/long for map display, but may use the exact lat/long for property search as long as exact property location is not displayed to the guest.

Key differences from Rapid lodging

  • Partners may request Geography responses with Vrbo and Rapid lodging, Vrbo only (using supply_source=vrbo on an enabled profile), or Rapid lodging only (using supply_source=expedia). If supply_source is not provided, Rapid Geography APIs will default to expedia.

Geography FAQ

Q. Can I filter the Geography APIs to only return Vrbo or only non-Vrbo properties?
A. Yes, partners may filter by using supply_source=vrbo. If the profile is not allowed to access Vrbo supply no results will be returned.

Content

Need to know

  • Vrbo content is provided via the same Rapid Content APIs as other Rapid lodging by passing supply_source=vrbo, but please note differences in the schema below.

Key differences from Rapid lodging

Vrbo-specific fields:

APIDescription
Content fileVrbo properties are provided in a separate content file from other Rapid lodging.
FieldDescription
vacation_rental_details:registry_numberRequired field for display of vacation rental properties. Please see launch requirements for more details.
private_host_property (Attribute ID 1073745102)Required for display, along with additional required descriptions. Please see launch requirements for more details.
professional_host_property (Attribute ID 1073745142)Required for display, along with additional required descriptions. Please see launch requirements for more details.
statisticsIncludes information specific to the vacation rental unit including max occupancy, number of bedrooms, number of bathrooms, number of rooms (1 when single-unit vacation rental), and property floor area (in square meters and feet). Should be used to display a summary of key property information in search results and at the top of property details page.
Bathroom and bedroom countAttribute 1073743378 'Number of Bedrooms' refers to the number of bedrooms within the unit. Attribute 1073743379 'Number of Bathrooms' refers to the number of bathrooms within the unit.
vacation_rental_details:property_managerIncludes the property manager name, image, and languages spoken when available. Should be used to introduce the guest to the host who manages the property. Contact information is provided after booking completion, as part of essential stay content.
vacation_rental_details:unit_configurationsDescribes the bed type(s) in a room and how many of each bed type are in the room. This information should be used to display a property layout to the guest, to provide confidence that the property can accommodate the guests' traveling party.
vacation_rental_details:house_rulesThis field has been deprecated. Please use vacation_rental_details:enhanced_house_rules instead.
vacation_rental_details:enhanced_house_rulesEnhanced house rules includes key policy information for pets, parties, children, smoking policy, and more. additional_information can include details of each policy critical to the guest's stay such as policy clarifications, access codes, passwords, images, and stay collected fees (city tourist taxes or usage-based charges). Please see the Vrbo essential stay content guide for more information.
vacation_rental_details:rental_agreementProvides link to a PDF or website provided by the property manager which must be displayed on any check-out page. Guest action to sign and return, or submit, the rental agreement may also be required.
vacation_rental_details: free_textThis is a free text field provided by the host which highlights the unique attributes or experiences available to guests at the property. This description may also include nearby attractions, optional services available from the host, or other important information (e.g. construction, noise, water conditions, ski slope access, parking, etc.) the guest should understand before making a booking. This section can be quite verbose, so careful attention should be paid to UI display of this field, particularly on mobile experiences.

When this field is not present, partners should fall back to Descriptions.General.
descriptions.generalProvides a machine-generated description of the vacation rental property based on property attributes, amenities, and location. This text does not include any guidance or information from the host. This field is most relevant to conventional lodging properties. This field should be used when vacation_rental_details.free_text is not present.
traveler_service_feeThis field has been deprecated. Please do not use. Please see launch requirements for recommended check-out display text.

Fields not relevant to Vrbo properties:

FieldDescription
Property ratingRatings are not available for Vrbo properties currently. Guest review scores may be used instead.
Room descriptionNot relevant to single-unit vacation rental properties. Room-level information should be used instead.
Rate planNot relevant to Vrbo properties.
Room level informationAll room description information is available at the property level. Because there is no room level content for Vrbo properties, amenities that are usually on the room level are included in a new section called vacation_rental_details.
vrbo_srp_id, listing_id, listing_number, listing_source, listing_unitThese fields are only relevant to the Vrbo link-off model, but may also be used for property mapping/matching.
IPM_NameUsed only by partners participating in the Vrbo IPM trial. Value provides the name of the IPM, and should be communicated to the guest to inform them of the merchant charging the guest card and sending the guest emails about their stay.

Content FAQs

Q. How do I map Vrbo content if the street address is not provided in Rapid Content?
A. Rapid Geography API and/or property lat/long values can be used to geo-locate properties.


Q. Are Vrbo properties included in Rapid Content files?
A. Yes, but in a Vrbo-specific content file when passing supply_source=vrbo in the API request.


Q. Are Vrbo properties available in all languages?
A. Yes, but some free text fields provided by the host are not localized.


Q. My guests do not know Vrbo, is display of the Vrbo brand required in all regions?
A. Display is required, but local Vrbo brands may be substituted in Germany, France, Australia, and New Zealand. Please see Appendix 2 below.


Q. Without bed_groups, how do I describe the bed types in each room?
A. Please see unit_configurations that returns in content which provides a bed type and room description.

Shop

Need to know

  • Vrbo properties are whole property only, no shared accommodations.
  • Vrbo properties are single-unit only.
  • Vrbo properties only return a single rate plan.
  • Properties with damage deposits must be excluded by passing exclusion=refundable_damage_deposit in the shopping request. Please see the advanced integration guide for more details on what to know before enabling these properties.
  • Properties with deposit policies are excluded. Please see the advanced integration guide below for more details.
  • Same day bookings are not supported (no availability will be returned).

Key topic: merchant_of_record for Vrbo bookings

The merchant_of_record field in Rapid Shop has a different meaning for Vrbo on Rapid properties, and should not be used at this time.

  • It does not represent who will charge the card provided with the booking.
  • It does not indicate timing of the payment (pay_now vs pay_later).

Key topic: Country codes for Vrbo bookings

Country code specified in the Shop request must match the billing country of the partner virtual card.

  • When mismatched, a booking error may result due to differing VAT collection requirements. Please see the advanced integration guide for more details.

Key Topic: Currency codes for Vrbo bookings

The currency specified in the Shop request does not affect the billing currency of the booking.

  • It is not possible to specify the currency for a Vrbo booking. The billing currency will always match the property's currency.

Key differences from Rapid lodging

Vrbo-specific fields:

FeeDescription
property_feeDescribes the total amount of property fees for the booking including cleaning fee, management fee, extra person fee, and others.
traveler_service_feeService fee charged by Vrbo to facilitate the booking and provide support. This fee is non-refundable as soon as any part of the booking is non-refundable. Please see launch requirements for more information about display.

Traveler service fees and Rapid Shop country selection: When a Vrbo includes a traveler service fee in the pricing response, the amount will include VAT corresponding to the country used in the Rapid Shop request. In order to make a successful booking, partners must ensure that the country requested in Shop matches the country of the payment to be used on check-out.

Fields not relevant to Vrbo properties:

FieldDescription
Room IDRoom name and Rate ID are not applicable to Vrbo inventory and should not be displayed.
Available roomsAlways 0 for Vrbo properties. Please don't use this field to indicate urgency.
Bed groupsNot applicable to Vrbo as no selection/preference is available.
Promo ID and descriptionNot applicable to Vrbo inventory.

Shop FAQs

Q. How can Vrbo properties be ranked?
A. Guest rating score/count can be used when present. Otherwise, your EPS partner connect contact can share a list of properties eligible for the Vrbo Premier Host Program. By using this indicator partners may identify properties managed by hosts qualified for the Premier Host Program, and use the same to influence property sort.

Q. How can I enable guests to search with pets?
A. Rapid does not currently offer the ability to filter by pet policy or to provide pet fee inclusive prices. Partners can identify pet-friendly properties based on content property attributes and guests can view individual pet policies. Hosts may provide additional information about pet policies within vacation_rental_details.free_text or enhanced_house_rules that may provide more detailed and accurate information about specific pet policies.

Q. Can I search for extended stays (i.e. longer than 28 nights)?
A. No, Rapid limits searches to a maximum of 28 nights at this time.

Q. Why do I not see the same fee breakdown on Rapid as on Vrbo.com?
A. Rapid is unable to break-out the property fee into individual components at this time. These components may include cleaning fee, management fee, extra person fees and other fees, and are combined into property_fees.

Q. I see properties return either merchant_of_record=expedia or merchant_of_record=property, and this changes depending on the date.
A. Some Vrbo supply cannot be booked as merchant, only as property collect. As a result, when only merchant supply is shopped, some available Vrbo properties will not be returned. The only way to shop and book those properties is to also include property collect in your shop request.

Q. Can I package Vrbo inventory?
A. Yes, however, Vrbo only offers stand-alone rates at this time. Further, if the guest accesses their Vrbo account they will see financial transaction details including amount paid.

Q. Are Vrbo properties eligible for members only deals?
A. Not at this time.

Q. Can I enable guest communication with the host during the shopping phase, prior to check-out?
A. Not at this time.

Q. Will I see the correct marketing fee in the availability response?
A. Please refer to gross_profit estimates and perform calculations based on your contracted agreement.

Q. Will rates for Vrbo on Rapid be consistent with rates on Vrbo and Expedia Group sites?
A. Prices for Vrbo supply on Rapid should mirror those that appear on the Expedia Group brand site, but may differ from prices appearing on Vrbo. This is often based on the service fee calculation, and may be slightly higher or lower. Additionally, the roll-up of property fees may differ slightly by brand.

Booking and Payment

Need to know

  • Partners must provide guest contact details (name, phone, and email) with each booking to facilitate host/guest communication.
  • Vrbo has stricter requirements for which countries need state and postal codes with a booking. More details in the advanced integration guide below.
  • Rental agreements, when provided in content, must be displayed on the check-out page. Please see launch requirements for more information.
  • Vrbo bookings via the Rapid API require a virtual card for payment. Partners wishing to send customer credit cards must refer to the advanced integration guide.
  • Billing currencies are pre-defined for Vrbo properties, so attention should be paid to virtual card credit limits. Partners should ensure that virtual cards reflect potential exchange rate differences and international bank charges in order to avoid insufficient funds booking errors.
  • Please note that Expedia Affiliate Collect (EAC) is not supported for Vrbo bookings on Rapid at this time. Properties which require multiple payments are not eligible for partner merchant of record. Please see the advanced integration guide for how to enable these properties.
  • Special requests are currently not relayed to the property.

Key topic: Property damage

Card-on-file:

  • Card-on-file indicates that Vrbo has the right to charge the provided card up to the amount returned in Rapid Shop after the guest departs the property if they have caused property damage. Vrbo will send a summary of damages and invoice to the guest when damage claims are made. If the charge to the card provided with the booking fails, Vrbo will send communications to the guest requesting they submit payment via the Vrbo site.
  • Guests should be informed of the amount that the property could charge if the property is damaged during their stay. This returns in the shop response under the card_on_file_limit object.

Key topic: Currency codes for Vrbo bookings

The currency specified in the Shop request does not affect the billing currency of the booking.

  • It is not possible to specify the currency for a Vrbo booking. The billing currency will always match the property's currency.
  • Virtual cards should be configured with a buffer sufficient to cover international exchange fees charged by the partner bank.

Key differences from Rapid lodging

Vrbo-specific fields:

FieldDescription
State/provinceRequirements differ from other Rapid hotel inventory. Please see below for more details.
Postal codeRequirements differ from other Rapid hotel inventory. Please see below for more details.

Fields not relevant to Vrbo properties:

FeatureDescription
Hold/resumeNot currently compatible for Vrbo on Rapid bookings.
Special requestSpecial requests cannot be communicated to the property at this time. Guests should communicate with the property after booking to make special requests.
Traveler handling instructionsNot supported for Vrbo bookings at this time.

Booking and payment FAQs

Q. What guest info is required with the booking request?
A. All Vrbo on Rapid bookings require the guest email and phone number to enable communications with the host. This is critical because hosts may provide stay-related information via email after the booking or prior to guest arrival, including coordination to meet the guest upon arrival or to relay door access codes.

Post-Book

Upon completion of a Vrbo booking via the Rapid API partners should provide guidance to the guest about the post-book experience. Suggested guidance topics include:

What to expect

  • Host may message guest (see below for sample topics), these emails will come from Vrbo (or the local Vrbo brand).
  • How to contact the host using contact information provided in Rapid essential stay content.

How to manage booking

  • Guests may cancel bookings via the partner site, based on Rapid’s Cancel API.
  • Guests may request changes to the host or support channel, or via cancel and re-book (recommended).

If there is an issue

  • Inform guests how to contact support (partner, Customer Direct Support (CDS), or Vrbo).
  • Advise guests contact support immediately when a problem arises, do not wait until post-stay to raise issues as Vrbo cannot resolve issues post-departure.
  • Partners may consider providing a link to the Vrbo site sign-in page. The guest will be asked to enter their email and then create a password. Once signed-in guests can access the booking management capabilities described below.

Note: The Vrbo confirmation number (HA-########) should be provided to guests as it is the only reference available to the host and Vrbo support, and is referenced within any Vrbo emails.

Key differences from Rapid lodging

Vrbo-specific fields:

FieldDescription
Essential stay contentRepresents the Vrbo welcome guide and should be provided to the guest immediately following booking creation. Please see Vrbo essential stay content for more details.

Fields not relevant to Vrbo properties:

FieldDescription
Cancel refund amountNot available for Vrbo on Rapid bookings.
Conversation tokenNot available for Vrbo on Rapid bookings.
Soft changeNot supported for Vrbo bookings. Guests should request changes to the host directly via email or contact support.
Hard changeNot supported for Vrbo bookings. Guests should request changes to the host directly via email or contact support.

Post Book FAQs

Q. What emails will my guest receive from Vrbo?
A. Guests will receive a Vrbo-branded booking confirmation email. They may also receive a Vrbo welcome guide email prior to arrival.

Q. What emails will my guest receive from the host (via Vrbo)?
A. Guests will receive conversations from the host using the guest's email sent during booking creation. Conversations may include information critical to the guest arrival and experience at the property, and also serve as a communication channel during stay.

Q. Can Vrbo on Rapid bookings be canceled via the Rapid Cancel API?
A. Yes, all Vrbo on Rapid bookings can be canceled using the cancel token on the Rapid itinerary response. Alternatively, guests can request cancel to the property manager, Vrbo support, or the Vrbo booking management page.

Q. What capabilities does Vrbo offer post booking on their website?
A. Vrbo offers booking management tools on their website that guests can access by using their email and creating a password. Most of these capabilities are also offered via Rapid and/or host-guest conversations:

  • Booking modifications:
    • Request cancellation. Guests may also cancel bookings on the partner site via the Rapid Cancel API.
    • Request changes to the booking (request is sent to the property manager). Guests may also request changes directly to the host via conversations/email.
    • View insurance offer.
  • Property and arrival information:
    • View arrival information. This information is also provided via essential stay content on the Rapid Itinerary API for partners to communicate to the guest.
    • Contact property manager (messaging). Guests may also respond to emails from the host.
    • View property manager name. This information is also provided via essential stay content on the Rapid Itinerary API for partners to communicate to the guest.
  • View payment details:
    • View payment schedule. This information is also provided to partners to display to the guest pre/post-booking.
    • View/download invoice/VAT receipt.

Q. How can Vrbo bookings be changed?
A. It is recommended that guests cancel and rebook, but guests can request changes to Vrbo bookings by communicating with the host, initiating a change request via support, or using Vrbo booking tools.

Q. Will I receive Rapid notifications for booking changes or cancellations?
A. Partners subscribed to Rapid notifications will receive notifications when a booking is canceled, but we are unable to differentiate between supplier cancels and user-requested cancels at this time. Changes to bookings do not initiate notifications.

Q. How do guests access Vrbo booking management tools, and what can they do there?
A. Guests will receive a booking confirmation email with links to manage their booking. Once on the Vrbo site they will need to create an account using the email provided with the booking. Guests can view their booking, initiate conversations with the host, download a service fee invoice, cancel or request to cancel the booking, request to change the booking, initiate a scheduled payment, and share their trip with others.

Q. Do Vrbo host conversations work with the Property Message Center?
A. Not at this time.

Q. How will guests receive check-in information?
A. Please see Vrbo essential stay content. Currently, Vrbo sends a Vrbo welcome guide to the guest approximately 3 days prior to arrival. The content of the welcome guide depends on the level of detail provided by the host. Hosts may instead send essential stay information as a conversation to the guest's email provided at time of book. To ensure guests receive this critical stay-related information, partners must provide essential stay content to the guest. Vrbo transactional comms will be suppressed in the future.

Q. Can the property cancel a Vrbo booking after it is confirmed?
A. Yes, property managers can cancel a Vrbo booking any time between booking and guest arrival. Often this happens within a day of creating the booking when the property manager realizes their property is no longer available on that date. If this happens prior to guest arrival, Vrbo’s book With confidence guarantee means Vrbo support will assist the guest with interim accommodations while they arrange a comparable vacation rental property. Frequency of property manager cancellation is a factor in determining premier host eligibility and impacts property placement in search results, so property managers are careful not to cancel unless necessary.

Advanced integration guide

Scenario 1: Refundable damage deposits (RDD)

Some Vrbo properties require collection of a damage deposit prior to arrival, providing a refund post-departure based on property condition.

About RDDs

  • Properties requesting RDDs may occur more frequently during periods of high compression such as holidays.
  • About 2% of properties require a refundable damage deposit pre-arrival.
  • RDD amount and requirement may vary by geography and season.

Guests must be informed

  • Payment of the damage deposit is made with the last scheduled payment (or at time of book if single payment).

RDD Example

  • Refund of damage deposits will be made within 12 days of departure based on the host's inspection.
  • Vrbo will send a damage invoice to the guest in case of damage.
  • The refundable damage deposit amount must be displayed on check-out.
  • The RDD amount displayed in Rapid Shop is an estimate. The amount from Rapid Price Check is the amount which will be charged to the guest, and must be displayed to the guest during check-out.

Partner merchant of record:

  • We recommend RDDs are excluded when partner provides payment via virtual card unless they are able to facilitate the collection and refund of the damage deposit with the guest.
  • Partners are responsible for displaying the amount to the guest and collecting/refunding accordingly.

Example:

"rates": [
    {
        "refundable_damage_deposit": {
            "value": "150.00",
            "currency": "USD"
        }  
    }
]

Scenario 2: Customer credit card

Use of customer credit cards requires additional validation and communication to the guest.

Address validation

  • Vrbo bookings require different address validation than Rapid lodging.

See below for details:

Countries with postal codesCountries without postal codesCountries with postal codes and additional details
countries-with-postal-codescountries-without-postal-codescountries-with-postal-codes-and-additional-details
AfghanistanAngolaAustralia: State
Åland IslandsAntigua and BarbudaBrazil: State (+Neighborhood on BR POSA) and CPF/CNPJ
AlbaniaArubaCanada: Province
American SamoaBahamasJapan: State and Address line 2
AndorraBelizeSpain: National ID
AnguillaBeninUnited States: State
AntarcticaBotswana
ArgentinaBurkina Faso
ArmeniaBurundi
AustriaCameroon
AzerbaijanCentral African Republic
BahrainComoros
BangladeshCongo
BarbadosCongo, the Democratic Republic of the
BelarusCook Islands
BelgiumCôte d'Ivoire
BermudaDjibouti
BhutanDominica
Bolivia, Plurinational State of†Equatorial Guinea
Bosnia and HerzegovinaEritrea
Bouvet IslandFiji
British Indian Ocean TerritoryFrench Southern Territories
Brunei DarussalamGambia
BulgariaGhana
CambodiaGrenada
Cape VerdeGuinea
Cayman IslandsGuyana
ChadHong Kong
ChileIreland††
ChinaKenya
Christmas IslandKiribati
Cocos (Keeling) IslandsMacao
ColombiaMalawi
Costa RicaMali
CroatiaMauritania
CubaMauritius
CyprusMontserrat
Czech RepublicNauru
DenmarkNiue
Dominican RepublicPanama
EcuadorQatar
EgyptRwanda
El SalvadorSaint Kitts and Nevis
EstoniaSaint Lucia
EthiopiaSao Tome and Principe
Falkland Islands (Malvinas)Seychelles
Faroe IslandsSierra Leone
FinlandSolomon Islands
FranceSomalia††
French GuianaSouth Africa††
French PolynesiaSuriname
GabonSyrian Arab Republic
GeorgiaTanzania, United Republic of
GermanyTimor-Leste
GibraltarTokelau
GreeceTonga
GreenlandTrinidad and Tobago
GuadeloupeTuvalu
GuamUganda
GuatemalaUnited Arab Emirates
Guinea-BissauVanuatu
HaitiYemen
Heard and McDonald Islands†Zimbabwe
Holy See (Vatican City State)
Honduras
Hungary
Iceland
India
Indonesia
Iran, Islamic Republic of
Iraq
Israel
Italy
Jamaica
Jordan
Kazakhstan
Korea, Republic of
Kuwait
Kyrgyzstan
Lao People's Democratic Republic
Latvia
Lebanon
Lesotho
Liberia
Libya†
Liechtenstein
Lithuania
Luxembourg
Macedonia, the former Yugoslav Republic of
Madagascar
Malaysia
Maldives
Malta
Marshall Islands
Martinique
Mayotte
Mexico
Micronesia, Federated States of
Moldova, Republic of
Monaco
Mongolia
Montenegro
Morocco
Mozambique
Myanmar
Namibia
Nepal
Netherlands
New Caledonia
New Zealand
Nicaragua
Niger
Norfolk Island
Northern Mariana Islands
Norway
Oman
Palau
Palestine, State of
Papua New Guinea
Paraguay
Peru
Philippines
Pitcairn
Poland
Portugal
Puerto Rico
Réunion
Romania
Russian Federation
Saint Barthélemy
Saint Helena, Ascension and Tristan da Cunha
Saint Pierre and Miquelon
Saint Vincent and the Grenadines
Samoa
San Marino
Senegal
Serbia
Serbia and Montenegro
Singapore
Slovakia
Slovenia
South Georgia and the South Sandwich Islands
Sri Lanka
Sudan
Svalbard and Jan Mayen
Swaziland
Sweden
Switzerland
Taiwan, Province of China
Tajikistan
Thailand
Togo†
Tunisia
Turkey
Turkmenistan
Turks and Caicos Islands
Ukraine
United Kingdom
United States Minor Outlying Islands
Uruguay
Uzbekistan
Venezuela, Bolivarian Republic of
Viet Nam
Virgin Islands, British
Virgin Islands, U.S.
Wallis and Futuna
Western Sahara
Zambia

†Countries with partial availability of zip/postal codes but maintained as mandatory on Vrbo check-out.
††Countries with partial availability of zip/postal codes but that we don't have as mandatory.

Guests must be informed

  • Description of who will charge their card.
  • Bank charges: Guests should be reminded that their bank may charge fees for international transactions.
  • Refunds: Guests should be reminded that exchange rate fluctuations may impact the refund amount.

Damages: Guests must be informed of the maximum charge amount and charge/refund timing

  • The maximum charge amount is provided in the Rapid Shop response under refundable_damage_deposit.
  • Damages will be charged to the guest card if the property is damaged, up to the specified maximum.
  • Vrbo will send a damage invoice to the guest in case of damage.

Booking error: Shop country differs from customer country (billing address)

The price for a Vrbo property can vary based on the location of the guest. The location is determined by the billing address input by the guest during check-out. As a result, partners must detect this mismatch prior to submitting the booking to avoid a booking error. If countries vary, partners must obtain a new price based on the guest's billing country.

Option 1: Prior to submitting the booking partners should compare the shopped country with the guest billing country. If different, re-shop using the billing address country, display updated price and allow guest to re-submit the booking.

Option 2: Limit billing address fields on check-out page to only the POSa country.

Scenario 3: Payment schedules

Vrbo properties sometimes collect payment based on a pre-defined schedule.

About deposits (payment schedules)

  • ~25% of properties provide a payment schedule for longer booking windows >3 months.
  • ~15% of properties provide a payment schedule for shorter booking windows <1 month.

Guests must be informed

  • Payment schedule detail should be shown during shop/check-out, ideally as a visual timeline view.

Example:

"deposits": [
              {
               "value": "412.10",
               "due": "2023-05-17",
               "currency": "USD"
              },
              {
               "value": "236.17",
               "due": "2023-08-24",
               "currency": "USD"
              }
             ]

payment-schedule-example


  • Guests must be informed that they are responsible for making payment on the Vrbo site according to the provided schedule or risk cancellation by the host.
  • Vrbo will send email reminders prior to, on, and after the payment due date to ensure the guest is aware of the payment requirement.

Combined with refundable damage deposits:

  • When RDD is required, it will be charged as part of the last scheduled payment. If single-payment, it will be collected at time of booking.

Combined with partner merchant of record:

  • Due to the manual payment requirement on Vrbo.com, we do not recommend properties with payment schedules be booked as partner as merchant of record.

Appendix 1: Host communications

All Vrbo bookings are required to include the customer email to facilitate direct communication between the property manager and the traveler. Use of a partner/agent email risks booking cancellation by the host in some cases.

Examples of property manager communications include:

  • Welcome message and introduction to the property manager
  • Contact details
  • Policies and know before you go
  • Address and directions
  • Key box code
  • Payment schedule
  • Rental agreement (may be required or property manager could cancel booking)
  • Passport photo request (may be required or property manager could cancel booking)
  • Cancel confirmation
  • Refund confirmation

Example:

property-manager-message

Appendix 2: Vrbo communications

The following Vrbo emails are suppressed for bookings made via the Rapid API:

  • Booking confirmation
  • Booking canceled by traveler
  • Booking canceled by property
  • Welcome guide
  • Re-marketing
  • Property review request
  • Support experience review request
  • Customer re-targeting post-cancel

Vrbo email templates specific to advanced integration scenarios:

  • Fraud cancel
  • Damage deposit charged
  • Damage deposit receipt
  • Damage deposit claimed
  • Scheduled payment overdue
  • Payment received
  • Payment refund

Vrbo.com guest interaction-based email templates:

  • Traveler requests cancel
  • Host responds to message
  • Traveler messages host
  • Account creation
  • Password reset
  • Password reset confirmation
  • Password creation
  • Guest invite
  • Guest invite follow-up
  • Additional payment request
  • Payment request
  • Payment reversed
  • Offline payment sent
  • Offline payment received
  • Payment confirmation
  • Payment cancel requested
  • Payment canceled
  • Booking updated
  • Booking change accepted, no payment
  • Booking change requested
  • VAT purchase receipt

Appendix 3: Customer facing brands

Point of saleCustomer-facing brand
FranceAbritel
GermanyFewo-Direkt
AustraliaStayz
New ZealandBookabach
OtherVrbo
Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve Developer Hub!