Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rate Plans Collection

API methods to work with Rate Plans

Rate Plan is a pricing plan of how to sell your Room Types. This contains information about prices and restrictions.

Rate Plans List

Retrieve a list of Rate Plans associated with user Properties.

Request:

GET https://staging.channex.io/api/v1/rate_plans

Pagination

By default, this method returns the first 10 elements. To get more details, you should use Pagination arguments. Information about count of entities and current pagination position contained at meta section at response object.

Returns

Success Method can return a Success result with 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 API Key provided.

Rate Plan Options

Method to get list of all room types associated with the current account without additional details and pagination limits.

Request:

GET https://staging.channex.io/api/v1/rate_plans/options?filter[property_id]={property_id}

Get Rate Plan by ID

Retrieve a specific Rate Plan by ID.

Request:

Returns

Success Method can return a Success result with 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 API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Rate Plan with provided ID is not present at system.

Create Rate Plan

Create a new Rate Plan.

All created rates will have default values set by Channex. Rate = 0, Stop sell = Off, Min Stay = 1. After you create a rate please use the Availability and Rates API to send values per day.

Request:

Query body (JSON):

Fields

title [required]

Any non-empty string with maximum length of 255 symbols. Should be unique per Property. Note: The Rate Plan will be represented in the system under that title.

property_id [required]

String with valid UUID of the Property ID that you would like to associate with the created Rate Plan.

room_type_id [required]

String with valid UUID of Room Type ID that you would like to associate with the created Rate Plan.

tax_set_id [optional]

String with valid UUID of Tax Set ID that you would like to associate with the created Rate Plan. If not provided, default Tax Set associated with Property will be used.

options [required]

Array of Occupancy Option objects.

parent_rate_plan_id [optional]

String with valid UUID of Rate Plan object what you would like to associate as parent with created Rate Plan.

currency [optional]

3 symbols long string with Currency Alphabetic code based at ISO 4217. Note: Field is optional, by default system set Currency from associated Property. Property can have Rate Plans with different Currencies.

sell_mode [optional]

String, allow only two values: 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.

rate_mode [optional]

String, allows only the next values: 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.

meal_type [optional]

String, allow only the next values:

  • 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

auto_rate_settings [optional]

Object with Auto Rate Settings structure. Field is optional generally, but required if rate_mode equal to auto. This object contain information how to increase or decrease rate options from primary occupancy option.

inherit_rate [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_closed_to_arrival [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_closed_to_departure [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_stop_sell [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_min_stay_arrival [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_min_stay_through [optional]

Boolean value. Field is optional. By default equal to false if parent_rate_plan_id is empty, true if parent_rate_plan_id is present. Allow Rate Plan derive min_stay_through from Parent Rate Plan. When Parent Rate Plan is changed, Rate Plan will be automatically updated.

inherit_max_stay [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_max_sell [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_max_availability [optional]

Boolean value. Field is optional. By default equal to false if 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.

inherit_availability_offset [optional]

Boolean value. Field is optional. By default equal to false if 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.

children_fee [optional]

String or non-negative integer value. Represent additional fee which should be added to normal price if guest is Children, based at Hotel Age Policy.

infant_fee [optional]

String or non-negative integer value. Represent additional fee which should be added to normal price if guest is Infant, based at Hotel Age Policy.

max_stay [optional]

Positive Integer or Array of 7 Positive Integers. Represent default values for Max Stay restriction. This value will be applied to created Rate Plan and for each new date what will be added in state. You can pass single value (for any day) or specify specific default value for each weekday by passing Array with 7 elements.

min_stay_arrival [optional]

Positive Integer or Array of 7 Positive Integers. Represent default values for Min Stay Arrival restriction. This value will be applied to created Rate Plan and for each new date what will be added in state. You can pass single value (for any day) or specify specific default value for each weekday by passing Array with 7 elements.

min_stay_through [optional]

Positive Integer or Array of 7 Positive Integers. Represent default values for Min Stay Through restriction. This value will be applied to created Rate Plan and for each new date what will be added in state. You can pass single value (for any day) or specify specific default value for each weekday by passing Array with 7 elements.

closed_to_arrival [optional]

Boolean or Array of 7 Booleans. Represent default values for Closed To Arrival restriction. This value will be applied to created Rate Plan and for each new date what will be added in state. You can pass single value (for any day) or specify specific default value for each weekday by passing Array with 7 elements.

closed_to_departure [optional]

Boolean or Array of 7 Booleans. Represent default values for Closed To Departure restriction. This value will be applied to created Rate Plan and for each new date what will be added in state. You can pass single value (for any day) or specify specific default value for each weekday by passing Array with 7 elements.

stop_sell [optional]

Boolean or Array of 7 Booleans. Represent default values for Stop Sell restriction. This value will be applied to created Rate Plan and for each new date what will be added in state. You can pass single value (for any day) or specify specific default value for each weekday by passing Array with 7 elements.

Occupancy Options

Occupancy options is an entity chained with a Rate Plan and represents prices for different count of guests. If you create Per Room Rate Plan you should pass Occupancy Option for maximum occupancy. For Per Person Rate Plan you should pass Occupancy Option for each possible count of adult guests.

Each Occupancy Option should have next fields:

occupancy [required]

Any positive integer value. Count of guests allowed for current Occupancy Option

is_primary [required]

Boolean value. Marker to show main Occupancy Option. Actual for derived options, because Main Option will be used as base point for calculations.

derived_option [optional]

Valid Derived Options Object. This field represent rules to derive and modify parent values for current rate occupancy option.

rate [optional]

Any positive integer value. This field represent default Rate value what will be applied to each date for new Rate Plan and for each date which is came into state after "UpdateDate" task when Channex open new future date.

Derived Options

Derived Options is rules to modify a value from Parent Rate Plan or Primary Occupancy Option. This field represented as Object and has next structure:

Usually this object contain information about Rate modification, but you can modify Min Stay Arrival, Availability Offset and other values.

Object should contain key of modified restriction and array of arrays with modification rules. Each modification rule should be represented as 2 items length Array, where first item is modification rule, second item is modification argument. Each modification rule applied to original value step-by-step, from left side to right.

Modification rules

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.

Example:

In that example we are take original value, 100 $ as example, then add 5% and then add 12.00$ and receive 117$ as result value.

You are not limited at count of modification rules.

Returns

Success Method can return a Success result with 201 Created 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 API Key provided.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Examples

Update Rate Plan

Update a Rate Plan.

Request:

Query body (JSON):

Fields

This method use same fields as Create Rate Plan method.

Returns

Success Method can return a Success result with 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 API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Rate Plan with provided ID is not present at system.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Remove Rate Plan

Remove a Rate Plan.

Request:

Flags

Because system is not allow to remove RatePlan associated with any channel, we expose additional feature flag - force. To remove RatePlan and unmap it from Channel you can use next request:

Please, be careful with that method, once Rate Plan was removed we can't restore it and any channel information.

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Meta object with message in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Rate Plan with provided ID is not present at system.

PreviousRoom Types CollectionNextAvailability and Rates

Last updated