Sign in

v1

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

Get Rate Plans by Property

Retrieve rate plans by the listing ID.

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.

get/rm-rate-plans-ext/rate-plans/listing/{listingId}

Path parameters

listingIdstring required

The property ID.

Query parameters

skipnumber required

The number of items to skip before starting to collect the result set.

limitnumber required

The numbers of items to return.

sortstring required

The field by which to sort the items returned. (link to list of filterable fields)

channelId'bookingCom' | 'manual_reservations' | 'booking_engine' required

The channel to which the rate plans apply.

Response

Success

listingIdstring required

Guesty property ID.

requestIdstring required

The request ID.

countnumber required
limitnumber required
skipnumber required

Example response

{
  "ratePlans": [
    {
      "_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"
    }
  ]
}