200 OK
401 Unauthorized
meta
section at response object.200 OK
HTTP Code if operation is successful. Will contain a list of Rate Plan objects in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized
HTTP Code if wrong Bearer Token provided. 200 OK
401 Unauthorized
200 OK
401 Unauthorized
404 Not Found
200 OK
HTTP Code if operation is successful. Will contain a Rate Plan object in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized
HTTP Code if wrong Bearer Token provided.404 Not Found
HTTP Code if Rate Plan with provided ID is not present at system.201 Created
401 Unauthorized
422 Unprocessable Entity
[required]
[required]
[required]
[required]
[optional]
[optional]
[optional]
per_room
or per_person
.
Field is optional, be default system set per_room
value.
Note: Sell mode for Rate Plan.
Per Room Rate Plan mean price is equal to any count of allowed guests. Price for 1 Guest will be same with price for 2 Guests.
Per Person Rate Plan used to create Rate Plans where price is calculated based at Guests count.[optional]
manual
, derived
, auto
, cascade
.
Field is optional, by default the system will set to manual
.
Note: Rate Mode field represent how to calculate rate for current Rate Plan. At Channex.io we have 4 possible ways to do that:
Manual - price is specified at options.rate field.
Derived - price derived from parent_rate_plan for primary occupancy option.
Cascade - price derived from parent_rate_plan for each occupancy option.
Auto - price calculated automatically based at price for primary occupancy option and auto_rate_settings.
Read more about Rate Modes and Derived options at our Rate Plan Section.[optional]
none
,all_inclusive
,breakfast
,lunch
,dinner
,american
,bed_and_breakfast
,buffet_breakfast
,carribean_breakfast
,continental_breakfast
,english_breakfast
,european_plan
,family_plan
,full_board
,full_breakfast
,half_board
,room_only
,self_catering
,bermuda
,dinner_bed_and_breakfast_plan
,family_american
,breakfast_and_lunch
,lunch_and_dinner
[optional]
rate_mode
equal to auto
.
This object contain information how to increase or decrease rate options from primary occupancy option.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive rate
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive closed_to_arrival
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive closed_to_departure
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive stop_sell
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive min_stay_arrival
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive max_stay
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive max_sell
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive max_availability
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[optional]
parent_rate_plan_id
is empty, true if parent_rate_plan_id
is present.
Allow Rate Plan derive availability_offset
from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.[required]
[required]
[optional]
[optional]
increase_by_amount
Add provided amount to original price.
increase_by_percent
Increase original value by provided percent value. Applicable only for Rate restriction.
decrease_by_amount
Decrease original value by provided amount.
decrease_by_percent
Decrease original value by provided percent value. Applicable only for Rate restriction.201 Created
HTTP Code if operation is successful. Will contain a Rate Plan object in the answer.401 Unauthorized
HTTP Code if wrong Bearer Token provided.422 Unprocessable Entity
HTTP Code if any validation rule is failed.200 OK
401 Unauthorized
404 Not Found
422 Unprocessable Entity
200 OK
HTTP Code if operation is successful. Will contain a Rate Plan object in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized
HTTP Code if wrong Bearer Token provided.404 Not Found
HTTP Code if Rate Plan with provided ID is not present at system.422 Unprocessable Entity
HTTP Code if any validation rule is failed.200 OK
401 Unauthorized
404 Not Found
200 OK
HTTP Code if operation is successful. Will contain a Meta object with message in the answer.401 Unauthorized
HTTP Code if wrong Bearer Token provided.404 Not Found
HTTP Code if Rate Plan with provided ID is not present at system.