Resource rates determine the cost of bookings based on the components included in them (hourly, half-day, daily, etc.).
For more information on resource rates, please see this article.
You can retrieve individual rates as well as a list of all your rates.
Rate
| Property | Type | Required | Description |
|---|---|---|---|
| useValueCredits | boolean | true | Determines whether coins can be used for this rate. |
| intervalLength | string | true | A resource rate needs to have a main component, which is either hour or day. |
| intervalCount | number | true | This is always set to 1, since the main interval can only be either hour/day and the intervalCount corresponds to that. |
| extras | array | false | An array of one-off plan _ids, that can be purchased additionally for each booking. |
| locations | Location | true | An array of location _ids, that determine for which location the plan is valid. If empty, the rate can be used for all locations. |
| amenities | Amenity | false | An array of amenity _ids, that determine which amenities are available for this rate. |
| bookingPolicy | id | true | The _id of the booking policy associated with the rate. Booking policies aren't available in the public API, it's best to check the policy in the UI. |
| name | string | true | The name of the rate. |
| description | string | false | A short description of the rate. |
| account | id | false | The _id of the billing account with which the rate is associated. If missing, the default "Booking fees" account rate will be used. |
| bookingCancellationPolicy | string | false | The _id of the cancellation policy associated with the rate. Booking policies aren't available in the public API, it's best to check the policy in the UI. |
| rates | array | true | An array containing the secondary components of the rate. |
| rates.intervalQuantity | number | true | Can be either 1 or 4 depending on the type of rate. 1 is used for most rates, 4 is used only for half-day rates. This is used for internal calculations mainly. |
| rates.price | number | true | The price of the secondary component. |
| rates.interval | string | true | Depending on the type of the component can be either hour, day, week or month. |
| rates.isWeekendRate | boolean | false | Determines if the rate is a weekend rate. If the parameter is missing then it's considered false. |
| rates.isOffRate | boolean | false | Determines if the rate is a non-business hours rate. If the parameter is missing then it's considered false. |
| rates.isHalfDayRate | boolean | false | Determines if the rate is a half-day rate. If the parameter is missing then it's considered false. |
| price | number | true | The price of the main component - i.e. either price per hour or price per day. |
| createdAt | string | readonly | The date when the rate was created. |
| createdBy | id | readonly | The user that created the rate. |