The rate objects (or resource rates) describe available resource rates in the system. Rates are very similar to the plans.
You can retrieve individual rates as well as a list of all your rates.
Here is the list of the plan object properties:
|name||string||true||The name of the plan in hand. It appears everywhere in the system.|
|extras||Extras||true||An array of _ids of the various extras associated with the rate. Each extra is the _id of a one-off billing plan.|
|amenities||array||true||An array of _ids of the various amenities associated with the rate.|
|price||number||true||The default hourly/daily price of the rate. If the rate consists of multiple rates, each one will have its own price|
|locations||Location||true||List of all locations where the rate is present. If empty, all locations are assumed.|
|intervalLength||object||true||The interval of the rate - can be either day or hour.|
|rates||array of objects||true||Contains all rates and their respective intervals. If there's a resource rate, that has both daily rates and hourly rates, they'll present as a separate object with a different intervalQuantity and boolean properties for whether it's a weekend rate or a half-day rate|
|bookingPolicy||string||false||The _id of the associated booking policy.|
This can be expanded using $populate=bookingPolicy.activeMemberRule and $populate=bookingPolicy.nonActiveMemberRule.
More on booking policies here
|code||string||false||External identifier for the rate. Usually used for accounting purposes.|
|bookingCancellationPolicy||string||false||The _id of the associated cancellation policy. It can be expanded into an object using $populate in order to get information on the policy itself (activeMemberConditions,nonActiveMemberConditions etc).|
|createdAt||date||readonly||The date when the rate has been created.|
|createdBy||id||readonly||The user that created the rate.|
|modifiedAt||date||readonly||The user that did the last modification to the rate. If no update is made this field will match the |
|modifiedBy||id||readonly||The user that did the last modification to the rate. Before the first modification, this field equals to the |