Merchandizing: Free Cancellation and Pay At Stay

This page describes the implementation of 'Free Cancellation' and 'Pay At Stay' merchandizing shown on Tripadvisor Hotel Availability search. To be eligible your API must be on version 8. Please note that the information below is only applicable for Hotel Availability response. Merchandizing will only be shown if your cheapest rate is free to cancel and/or pay at stay. There is currently no merchandizing for non-refundable or partially-refundable rates. Information must be correct on the partner's landing page. Partners should only support this feature if it has minimal to no impact on their response time.

Free Cancellation

To be eligible for 'Free Cancellation' merchandizing your Hotel Availability response should return cancellation_policy in RatePlans. Not all objects in cancellation_policy are required, to reduce complexity it is recommended that you only send the following:

cancellation_policy  object

 

"cancellation_policy": {
  "cancellation_summary": {
    "refundable": "full",
    "cancellation_deadline": "2019-06-15T00:00:00Z"
  },
Name Type Description
cancellation_summary array of objects

A summary of the fee schedule associated with cancellation.

refundable string

This field is mandatory. Must be treated as dynamic and change over time according to the cancellation policy and deadline.

Must be one of:

  • none - "no refund provided if cancelled"
  • full -  "There exists a time between time of booking and time of arrival where the reservation may be cancelled without any charge to the user. Reservations whose free cancellation expires within N days of time of arrival may still be marked fully refundable unless time of booking is within N days of time of arrival"

Note: These fields are case sensitive and should be set as displayed above, they should not be for example 'Full' or 'None'.
 cancellation_deadline  string Required if refundable is set to full. The date and time after which it is not free to cancel a reservation. Must be in ISO8601 date-time format, which includes time zone, e.g. YYYY-MM-DDT00:00:00+00:00.

 

Pay at Stay

To be eligible for 'Pay At Stay' merchandizing your Hotel Availability response should return "paid_at_checkout" : true for all LineItems:

            "line_items": [
              {
                "price": {
                  "requested_currency_price": {
                    "amount": 220,
                    "currency": "USD"
                  }
                },
                "type": "rate",
                "paid_at_checkout": true,
                },
              {
                "price": {
                  "requested_currency_price": {
                    "amount": 20,
                    "currency": "USD"
                  }
                },
                "type": "tax",
                "sub_type": "tax_city",
                "paid_at_checkout": true,
                }
            ]
          },