Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Open Api Rate Plan CRUD v1

patch rate plan

patch rate plan.

Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for <a href="http://Booking.com">Booking.com</a> and direct reservations.

To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.

patch/rm-rate-plans-ext/rate-plans/{ratePlanId}

Path parameters

ratePlanIdstring required

The rate plan ID.

Request body

namestring required

Rate plan name.

descriptionstring

Describe the rate plan.

type'independent' required

Rate plan type.

pricingModel'nightly_rate' nullable

The pricing model.

cancellationPolicy'strict' | 'strict_60' | 'strict_90' | 'super_strict' | 'moderate' | 'semi_moderate' | 'semi_flexible' | 'firm' | 'flex' | 'free' | 'special' | 'direct_reservation_long_stay' nullable

The rate plan cancellation policy.

cancellationFee100 | 50 | 0 nullable

The rate plan cancellation fee.

channelSyncstring[]

The channel to which the rate plan applies.

mealPlansstring[]

Rate plan meal plans.

activeboolean required

Indicates whether the rate plan is active or not.

Example request

{
  "name": "My RatePlan",
  "description": "Rate plan description.",
  "type": "independent",
  "pricingModel": "nightly_rate",
  "cancellationPolicy": "strict",
  "cancellationFee": 100,
  "channelSync": [
    "bookingCom"
  ],
  "mealPlans": [
    "dinner",
    "lunch"
  ],
  "availabilityRules": {
    "advanceNotice": 1,
    "bookingWindow": 3
  },
  "active": true
}

Response

Success

requestIdstring required

request id

Example response

{
  "ratePlan": {
    "_id": "5fae51c4fdff570029b147e8",
    "accountId": "5213a2d206112710005d96ff",
    "type": "independent",
    "name": "My rate plan",
    "description": "My rate plan description",
    "cancellationPolicy": "firm",
    "mealPlans": [
      "all_inclusive"
    ],
    "availabilityRules": {
      "advanceNotice": 10,
      "bookingWindow": 20
    },
    "pricingModel": "nightly_rate",
    "channelSync": [
      "bookingCom"
    ],
    "active": true,
    "createdAt": "2023-12-01T04:09:27.335Z",
    "updatedAt": "2023-12-01T04:09:27.335Z"
  }
}