Rate plans and subscriptions
Hotels share rate plans with you: some with every agency, some with you by name. You sell a rate plan once you subscribe to it. These three calls let you see what is shared with you, compare the terms, and subscribe or unsubscribe from your own system, without logging in to your Quendoo account.
GET /rate-plans
Every rate plan shared with you, subscribed or not.
| Parameter | Required | |
|---|---|---|
locale |
yes | Language of the texts |
properties |
no | Comma-separated property ids |
subscribed |
no | true (or 1) for only the plans you sell, false (or 0) for only the ones you could add; any other value is error 1 |
Each rate plan carries:
| Field | Meaning |
|---|---|
id, name, description |
The rate plan |
property |
id and name of the hotel it belongs to |
subscribed |
Whether you sell it now |
subscribed_timestamp |
When you first subscribed, as Unix time (subscribing again after an unsubscribe keeps the first time); null when not subscribed |
booking_types |
search: bookable from a search; fit: bookable at your own price |
agency_info |
commission_type: net, or commission with commission_percent |
meal_plan_code, meal_plan_name |
BO, BB, HB, FB, AI or UAI, and its name |
payment_policy, cancellation_policy |
The terms, as in Content |
extra_services_included, extra_services_available |
Extras in the price, and extras sold on top |
rooms |
The rooms it sells in: id, name, and sell_type for that room |
These are the same fields GET /properties gives for the
plans you already sell, so a plan reads the same before and after you
subscribe.
A rate plan stops being listed when the hotel stops sharing it with you, switches it off for your agency, deactivates it or deletes it, when its property is deleted, or when it is no longer sold in any room.
POST /rate-plans/subscribe
{ "rate_plans": [11058, 11059] }
The answer:
[
{ "id": 11058, "subscribed": true },
{ "id": 11059, "subscribed": true }
]
From that moment the plans appear in /properties, /rates-restrictions
and /availabilities, and you can book them the ways their
booking_types allow: search for /search, POST /booking and
auto-price, fit for with-price.
POST /rate-plans/unsubscribe
{ "rate_plans": [11059] }
The answer lists the same ids with "subscribed": false.
You stop selling the plan. Your bookings on it stay as they are: you can still read them and cancel them, but you can no longer change their details through the API.
You can also unsubscribe from a plan the hotel no longer shares with you, to clear it from your account.
Rules
- All or nothing. If one id cannot be subscribed to (it is not shared with you, or does not exist), the whole request is refused with error 8 for that id, and nothing changes.
- Safe to retry. Subscribing to a plan you already sell, or unsubscribing from one you do not sell but that is still shared with you, succeeds and changes nothing. Unsubscribing again from a plan the hotel no longer shares, after the first unsubscribe went through, is error 8.
- The body is exact.
rate_plansmust be a non-empty list of positive integers, and nothing else may be in the body (error 4). - The hotel decides what is shared. Subscribing is your side of it. If you expected a plan that is not listed, ask the hotel to share it with your agency.
What else a plan lets you do
Besides booking_types, the hotel can allow, on plans with
booking_types.fit only:
- changing a booking's client and guest details (
PATCH /booking); - sending booking requests (
request-with-price,request-auto-price); - booking in a currency other than the property's;
- booking without the availability check.
These are not listed by the API. Ask the hotel which of them your agency has on each plan.
Keeping your catalogue in step
After you subscribe or unsubscribe, refresh Content and Prices and availability for that hotel, so your system shows exactly what you can now sell.