rate-plans.list
read-only
List all rate plans for the tenant. Returns id, name, isDefault, priority, refundable, cancellationWindowHours, minLeadTimeHours, maxLeadTimeDays, guestSegment, and inheritFromId. Ordered by priority then name.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
plans | array of object | yes | |
plans.id | string | yes | |
plans.name | string | yes | |
plans.isDefault | boolean | yes | |
plans.priority | integer | yes | |
plans.refundable | boolean | yes | |
plans.paymentMode | enum | yes | One of: stripe, pay_at_hotel |
plans.cancellationWindowHours | integer | yes | |
plans.minLeadTimeHours | integer · nullable | yes | |
plans.maxLeadTimeDays | integer · nullable | yes | |
plans.guestSegment | string · nullable | yes | |
plans.inheritFromId | string · nullable | yes |