Actions67
- Addon Actions
- Door Lock Actions
- Event Actions
- Guest Actions
- Housekeeping Actions
- Integration Event Actions
- Item Actions
- Market Segmentation Actions
- Payment Actions
- Property Actions
- Rate Actions
- Reservation Actions
- Room Actions
- Webhook Actions
Rate → Get Rate Plans
AI-generatedSummary
Fetch rate plans from Cloudbeds for a specified date range, optionally filtered by room type ID.
Inputs
- authentication — Authentication method to use for API access. Defaults to accessToken if not specified. Options include Access Token or OAuth2.
- startDate (required) — Start date for the rate query in YYYY-MM-DD format. Defines the beginning of the date range for rate plan retrieval.
- endDate (required) — End date for the rate query in YYYY-MM-DD format. Defines the end of the date range for rate plan retrieval.
- roomTypeId — Filter results by a specific room type ID (e.g., 671015). Leave empty to retrieve rate plans for all room types.
Output shape
Array of rate plan objects returned from the Cloudbeds API, each containing plan details for the specified date range and optional room type filter.
Authentication defaults to accessToken. The operation consumes startDate and endDate as required date boundaries; roomTypeId is optional and, when omitted, returns all room types. No side effects beyond the API query.
Examples
Example 1: Retrieve all rate plans between 2024-01-01 and 2024-12-31 using an access token.
authentication: accessToken; startDate: 2024-01-01; endDate: 2024-12-31; roomTypeId: (empty)