Fetch rate plan adjustments for your listings

GET

https://api.pricelabs.co/v1/fetch_rate_plans

GET

/v1/fetch_rate_plans

$ curl -G https://api.pricelabs.co/v1/fetch_rate_plans \
>      -H "X-API-Key: {{API_KEY}}" \
>      --data-urlencode listing_id={{listing_id}} \
>      --data-urlencode pms_name={{pms_name}}

1 {
2   "rate_plans": {
3     "id": "12345",
4     "pms": "airbnb",
5     "name": "My Listing",
6     "rateplans": {
7       "101": {
8         "name": "Standard Rate",
9         "type": "percent",
10         "default": "true",
11         "plan_type": "derived",
12         "adjustment": 0,
13         "update_type": "price and restrictions"
14       },
15       "102": {
16         "name": "Non-refundable",
17         "type": "percent",
18         "default": "false",
19         "plan_type": "derived",
20         "adjustment": -10,
21         "update_type": "price and restrictions"
22       }
23     }
24   }
25 }

If your listings have rate plan adjustments, you can use this API call to fetch those adjustments. You can fetch the prices for the default rate plan using the POST /v1/listing_prices call and use the adjustments returned in this call to derive the prices of the non-default rate plans for your system.

Query parameters

listing_idstringRequired

pms_namestringRequired

Response

Success

rate_plansobject

Errors

403

Forbidden Error

Headers

Query parameters

Response

Errors