Get Plan Options for Channel and Room Types

Returns all available payment plans for a given set of room type and bed requests, along with a pre-generated payment schedule for each plan. Use this after Get Bed Availability to present pricing and payment options to a prospective resident before creating a booking.

Request Body

Field	Type	Required	Description
`propertyId`	number	Yes	The ID of the property. Obtain from Get Property Listings
`channelId`	number	Yes	The channel ID. Obtain from Get Channels
`startDateTime`	datetime	Yes	The desired move-in date and time (ISO 8601 format with timezone, e.g. `2026-07-18T15:40:41+05:30`)
`endDateTime`	datetime	Yes	The desired move-out date and time (ISO 8601 format with timezone, e.g. `2026-09-18T15:40:41+05:30`)
`bedRequests`	array	Yes	List of bed requests — one per room type being booked (see below)

`bedRequests` Object

Field	Type	Required	Description
`roomTypeId`	number	Yes	The ID of the room type. Obtain from Get Room Type Listings
`roomTypeRateId`	number	Yes	The ID of the specific rate to apply for this room type
`bedCount`	number	Yes	Number of beds being requested for this room type

What's Returned

The response returns a paymentPlans array. Each plan includes:

Field	Description
`id`	Unique ID of the payment plan
`name`	Display name of the plan (e.g. `Booking Monthly Plan`)
`status`	Whether the plan is `Active` or not
`constraints`	Min and max term length in days that this plan supports
`isDisabled` / `reasonForDisable`	Whether the plan is applicable for the given request and why
`form`	A list of input fields the plan requires — used to configure `planInputs` when calling Generate Plan. Each field has a `name`, `label`, `fieldType`, and optionally `defaultValue` and `options`
`generated`	A pre-calculated payment schedule based on default plan inputs (see below)

`generated` Object

Field	Description
`plan`	Array of payment entries across the tenancy term, each with `billingDate`, `dueDate`, `payableAmount`, `taxAmount`, and a breakdown of `paymentItems` (rent, deposit, etc.)
`planMeta`	Summary of the plan inputs used, including `rent`, `security`, `reservation`, and `discount`, along with a human-readable `planMessage`
`startDateTime` / `endDateTime`	The term dates used for generation
`noticePeriodDays`	Notice period applicable for this plan

Note: The form field tells you exactly which planInputs values are needed when calling Generate Plan for Channel and Room Types. Use the name field of each form item as the key, and the defaultValue or user-selected value as the value.

Authentication

This endpoint requires a valid Bearer Token in the Authorization header. Obtain one via the Credential Refresh endpoint.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://server.wardenera.com/api/v1/external-app/get-plan-options-for-channel-and-room-types' \ --header 'User-Agent: insomnia/11.4.0' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "propertyId": 412, "channelId": 32, "startDateTime": "2026-07-18T15:40:41+05:30", "endDateTime": "2026-09-18T15:40:41+05:30", "bedRequests": [ { "roomTypeId": 1385, "roomTypeRateId": 1419, "bedCount": 1 }, ] }'

{ "paymentPlans": [ { "id": 12, "constraints": { "maxTermLengthDays": 199, "minTermLengthDays": 0 }, "contracts": { "Booking Folio": 85, "Rent Agreement": 48, "Resident Rent Agreement": 123 }, "name": "Booking Monthly Plan", "description": null, "status": "Active", "isDeleted": false, "companyId": 11, "createdById": 8091, "updatedById": 8091, "createdAt": "2025-06-05T15:57:56+05:30", "updatedAt": "2026-02-18T18:51:02+05:30", "label": "Booking Monthly Plan", "value": 12, "form": [ { "name": "planInputs.reservationMode", "label": "Reservation Mode", "options": [ { "label": "Reserve Now, Book Later", "value": "Reserve Now, Book Later" }, { "label": "Full Booking", "value": "Full Booking" } ], "isHidden": false, "fieldType": "SingleSelect", "isProtected": false, "defaultValue": "Full Booking", "isDisplayValue": true, "isBookingEngineField": true }, { "name": "planInputs.rent", "label": "Monthly Rent", "isHidden": false, "fieldType": "AmountInput", "isProtected": false, "isDisplayValue": true, "chartOfAccountId": 1378 }, { "name": "planInputs.security", "label": "Deposit Amount", "options": [], "isHidden": false, "fieldType": "AmountInput", "isProtected": false, "isDisplayValue": true, "chartOfAccountId": 1376 }, { "name": "planInputs.reservation", "label": "Reservation Amount", "options": [], "isHidden": false, "fieldType": "AmountInput", "isProtected": false, "isDisplayValue": true, "chartOfAccountId": 555 }, { "name": "planInputs.discount", "label": "Discount", "options": [], "isHidden": false, "fieldType": "DiscountInput", "isProtected": false, "defaultValue": 0, "isDisplayValue": true } ], "isDisabled": false, "reasonForDisable": "All constraints met", "generated": { "plan": [ { "taxableAmount": 55424.1, "deductedTaxAmount": 0, "payableAmount": 56075, "grossPayableAmount": 56075, "baseAmount": 55424.1, "taxAmount": 650.9, "discount": 0, "totalAmount": 56075, "entry": "Plan Generator", "type": "Rent Collection", "category": "Initial Payment", "billingDate": "2026-05-03T13:45:13+05:30", "dueDate": "2026-05-10T13:45:13+05:30", "paymentItems": [ { "id": 0, "paymentId": 0, "chartOfAccountId": 1376, "companyId": 0, "description": "Security deposit", "inputAmount": 50000, "discount": 0, "isSettled": false, "originalTimezone": "Asia/Kolkata", "isDeleted": false, "createdById": 0, "updatedById": 0, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30", "taxableAmount": 50000, "baseAmount": 50000, "taxAmount": 0, "computedTaxAmount": 0, "exemptedTaxAmount": 0, "deductedTaxAmount": 0, "payableAmount": 50000, "grossPayableAmount": 50000, "taxesUsed": [], "label": "Security Deposit", "SACCode": "", "chartOfAccount": { "id": 1376, "name": "Security Deposit", "type": "Security", "description": "", "SACCode": "", "companyId": 11, "taxId": null, "beneficiaryId": null, "advanceCOAId": null, "provisionalCOAId": 1377, "taxDeductionId": null, "isDeleted": false, "isArchived": false, "createdById": 8091, "updatedById": 8091, "createdAt": "2025-06-09T18:11:52+05:30", "updatedAt": "2025-06-09T18:11:52+05:30", "taxConnections": [], "taxExemptionConnections": [], "taxDeductionConnections": [], "taxIds": [], "taxes": [], "applicableTaxExemptionIds": [], "applicableTaxExemptions": [], "applicableTaxDeductionIds": [], "applicableTaxDeductions": [], "classType": "Liability" } }, { "id": 0, "paymentId": 0, "chartOfAccountId": 1378, "companyId": 0, "description": "Rent for the month of Jul 2026", "inputAmount": 6075, "discount": 0, "isSettled": false, "originalTimezone": "Asia/Kolkata", "isDeleted": false, "createdById": 0, "updatedById": 0, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30", "taxableAmount": 5424.1, "baseAmount": 5424.1, "taxAmount": 650.9, "computedTaxAmount": 650.9, "exemptedTaxAmount": 0, "deductedTaxAmount": 0, "payableAmount": 6075, "grossPayableAmount": 6075, "taxesUsed": [ { "taxId": 60, "taxType": "Inclusive", "paymentItemId": 0, "computedAmount": 325.45, "exemptedAmount": 0, "amount": 325.45, "tax": { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30" }, { "taxId": 61, "taxType": "Inclusive", "paymentItemId": 0, "computedAmount": 325.45, "exemptedAmount": 0, "amount": 325.45, "tax": { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30" } ], "label": "Rent", "SACCode": "", "chartOfAccount": { "id": 1378, "name": "Rent", "type": "Income", "description": "", "SACCode": "", "companyId": 11, "taxId": null, "beneficiaryId": null, "advanceCOAId": 1380, "provisionalCOAId": 1379, "taxDeductionId": null, "isDeleted": false, "isArchived": false, "createdById": 8091, "updatedById": 8091, "createdAt": "2025-06-09T18:13:04+05:30", "updatedAt": "2025-06-09T18:13:04+05:30", "taxConnections": [ { "taxId": 60, "chartOfAccountId": 1378, "tax": { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "createdById": 13581, "updatedById": 13581, "isDeleted": false, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } }, { "taxId": 61, "chartOfAccountId": 1378, "tax": { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "createdById": 13581, "updatedById": 13581, "isDeleted": false, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } } ], "taxExemptionConnections": [], "taxDeductionConnections": [], "taxIds": [ 60, 61 ], "taxes": [ { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } ], "applicableTaxExemptionIds": [], "applicableTaxExemptions": [], "applicableTaxDeductionIds": [], "applicableTaxDeductions": [], "classType": "Revenue" } } ] }, { "taxableAmount": 12053.58, "deductedTaxAmount": 0, "payableAmount": 13500, "grossPayableAmount": 13500, "baseAmount": 12053.58, "taxAmount": 1446.42, "discount": 0, "totalAmount": 13500, "entry": "Plan Generator", "type": "Rent Collection", "category": "Rent", "billingDate": "2026-08-01T00:00:00+05:30", "dueDate": "2026-08-08T00:00:00+05:30", "paymentItems": [ { "id": 0, "paymentId": 0, "chartOfAccountId": 1378, "companyId": 0, "description": "Rent for the month of Aug 2026", "inputAmount": 13500, "discount": 0, "isSettled": false, "originalTimezone": "Asia/Kolkata", "isDeleted": false, "createdById": 0, "updatedById": 0, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30", "taxableAmount": 12053.58, "baseAmount": 12053.58, "taxAmount": 1446.42, "computedTaxAmount": 1446.42, "exemptedTaxAmount": 0, "deductedTaxAmount": 0, "payableAmount": 13500, "grossPayableAmount": 13500, "taxesUsed": [ { "taxId": 60, "taxType": "Inclusive", "paymentItemId": 0, "computedAmount": 723.21, "exemptedAmount": 0, "amount": 723.21, "tax": { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30" }, { "taxId": 61, "taxType": "Inclusive", "paymentItemId": 0, "computedAmount": 723.21, "exemptedAmount": 0, "amount": 723.21, "tax": { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30" } ], "label": "Rent", "SACCode": "", "chartOfAccount": { "id": 1378, "name": "Rent", "type": "Income", "description": "", "SACCode": "", "companyId": 11, "taxId": null, "beneficiaryId": null, "advanceCOAId": 1380, "provisionalCOAId": 1379, "taxDeductionId": null, "isDeleted": false, "isArchived": false, "createdById": 8091, "updatedById": 8091, "createdAt": "2025-06-09T18:13:04+05:30", "updatedAt": "2025-06-09T18:13:04+05:30", "taxConnections": [ { "taxId": 60, "chartOfAccountId": 1378, "tax": { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "createdById": 13581, "updatedById": 13581, "isDeleted": false, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } }, { "taxId": 61, "chartOfAccountId": 1378, "tax": { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "createdById": 13581, "updatedById": 13581, "isDeleted": false, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } } ], "taxExemptionConnections": [], "taxDeductionConnections": [], "taxIds": [ 60, 61 ], "taxes": [ { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } ], "applicableTaxExemptionIds": [], "applicableTaxExemptions": [], "applicableTaxDeductionIds": [], "applicableTaxDeductions": [], "classType": "Revenue" } } ] }, { "taxableAmount": 7232.14, "deductedTaxAmount": 0, "payableAmount": 8100, "grossPayableAmount": 8100, "baseAmount": 7232.14, "taxAmount": 867.86, "discount": 0, "totalAmount": 8100, "entry": "Plan Generator", "type": "Rent Collection", "category": "Rent", "billingDate": "2026-09-01T00:00:00+05:30", "dueDate": "2026-09-08T00:00:00+05:30", "paymentItems": [ { "id": 0, "paymentId": 0, "chartOfAccountId": 1378, "companyId": 0, "description": "Rent for the month of Sep 2026", "inputAmount": 8100, "discount": 0, "isSettled": false, "originalTimezone": "Asia/Kolkata", "isDeleted": false, "createdById": 0, "updatedById": 0, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30", "taxableAmount": 7232.14, "baseAmount": 7232.14, "taxAmount": 867.86, "computedTaxAmount": 867.86, "exemptedTaxAmount": 0, "deductedTaxAmount": 0, "payableAmount": 8100, "grossPayableAmount": 8100, "taxesUsed": [ { "taxId": 60, "taxType": "Inclusive", "paymentItemId": 0, "computedAmount": 433.93, "exemptedAmount": 0, "amount": 433.93, "tax": { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30" }, { "taxId": 61, "taxType": "Inclusive", "paymentItemId": 0, "computedAmount": 433.93, "exemptedAmount": 0, "amount": 433.93, "tax": { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, "createdAt": "2026-05-03T13:45:13+05:30", "updatedAt": "2026-05-03T13:45:13+05:30" } ], "label": "Rent", "SACCode": "", "chartOfAccount": { "id": 1378, "name": "Rent", "type": "Income", "description": "", "SACCode": "", "companyId": 11, "taxId": null, "beneficiaryId": null, "advanceCOAId": 1380, "provisionalCOAId": 1379, "taxDeductionId": null, "isDeleted": false, "isArchived": false, "createdById": 8091, "updatedById": 8091, "createdAt": "2025-06-09T18:13:04+05:30", "updatedAt": "2025-06-09T18:13:04+05:30", "taxConnections": [ { "taxId": 60, "chartOfAccountId": 1378, "tax": { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "createdById": 13581, "updatedById": 13581, "isDeleted": false, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } }, { "taxId": 61, "chartOfAccountId": 1378, "tax": { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "createdById": 13581, "updatedById": 13581, "isDeleted": false, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } } ], "taxExemptionConnections": [], "taxDeductionConnections": [], "taxIds": [ 60, 61 ], "taxes": [ { "id": 60, "type": "Inclusive", "name": "SGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" }, { "id": 61, "type": "Inclusive", "name": "CGST", "percentage": 6, "validFrom": null, "validTo": null, "companyId": 11, "isDeleted": false, "createdById": 13581, "updatedById": 13581, "createdAt": "2024-05-20T03:06:41+05:30", "updatedAt": "2024-05-20T03:06:41+05:30" } ], "applicableTaxExemptionIds": [], "applicableTaxExemptions": [], "applicableTaxDeductionIds": [], "applicableTaxDeductions": [], "classType": "Revenue" } } ] } ], "planMeta": { "id": 0, "planType": "Fixed", "planInputs": { "reservationMode": "Full Booking", "reservation": 2500, "security": 50000, "rent": 13500 }, "displayPlanInputs": { "rent": 13500, "security": 50000, "reservation": 2500, "discount": 0, "bedCount": 1 }, "generatorMethod": { "label": "Booking Monthly Plan", "form": [ { "name": "planInputs.reservationMode", "label": "Reservation Mode", "options": [ { "label": "Reserve Now, Book Later", "value": "Reserve Now, Book Later" }, { "label": "Full Booking", "value": "Full Booking" } ], "isHidden": false, "fieldType": "SingleSelect", "isProtected": false, "defaultValue": "Full Booking", "isDisplayValue": true, "isBookingEngineField": true }, { "name": "planInputs.rent", "label": "Monthly Rent", "isHidden": false, "fieldType": "AmountInput", "isProtected": false, "isDisplayValue": true, "chartOfAccountId": 1378 }, { "name": "planInputs.security", "label": "Deposit Amount", "options": [], "isHidden": false, "fieldType": "AmountInput", "isProtected": false, "isDisplayValue": true, "chartOfAccountId": 1376 }, { "name": "planInputs.reservation", "label": "Reservation Amount", "options": [], "isHidden": false, "fieldType": "AmountInput", "isProtected": false, "isDisplayValue": true, "chartOfAccountId": 555 }, { "name": "planInputs.discount", "label": "Discount", "options": [], "isHidden": false, "fieldType": "DiscountInput", "isProtected": false, "defaultValue": 0, "isDisplayValue": true } ], "id": 12, "constraints": { "maxTermLengthDays": 199, "minTermLengthDays": 0 }, "contracts": { "Booking Folio": 85, "Rent Agreement": 48, "Resident Rent Agreement": 123 }, "name": "Booking Monthly Plan", "description": null, "status": "Active", "isDeleted": false, "companyId": 11, "customScriptConnections": [], "createdById": 8091, "updatedById": 8091, "createdAt": "2025-06-05T15:57:56+05:30", "updatedAt": "2026-02-18T18:51:02+05:30", "customScripts": [], "value": 12 }, "planMessage": { "title": "Monthly Plan", "description": "Payments are generated upfront, with pro rata calculation in the first and last months.", "priceString": "13,500/month" }, "bookingId": 0, "createdById": 0, "updatedById": 0, "createdAt": "2026-05-03T13:45:12+05:30", "updatedAt": "2026-05-03T13:45:12+05:30", "planEndDate": "2026-09-18T15:40:41+05:30", "noticePeriodDays": 30 }, "startDateTime": "2026-07-18T15:40:41+05:30", "endDateTime": "2026-09-18T15:40:41+05:30", "termStartDate": "2026-07-18T15:40:41+05:30", "termEndDate": "2026-09-18T15:40:41+05:30", "noticePeriodDays": 30 } } ], "message": "Payment Plans are fetched for externl booking" }

Get Plan Options for Channel and Room Types

Request Body#

bedRequests Object#

What's Returned#

generated Object#

Authentication#

Request

Responses

Request Body

`bedRequests` Object

What's Returned

`generated` Object

Authentication