Wix Rentals has no APIs of its own. It stores its services, bookings, and calendar events in the same entities as Wix Bookings, using field values and restrictions specific to rentals.
This article maps each rentals concept to the API that manages it.
A rental offering is a service with the following field values:
type is always APPOINTMENT.appId is always ff5d6eb1-65e4-4f9a-8b14-64d34c12cc2e.schedule.availabilityConstraints.durationRange replaces sessionDurations. These fields are mutually exclusive, so a service uses 1 or the other.schedule.availabilityConstraints.durationRange.unitType is either HOUR or DAY. Each unit type has its own configuration:
hourOptions.minDurationInMinutes and hourOptions.maxDurationInMinutes. Both values range from 30 to 1440 minutes.dayOptions.minDurationInDays and dayOptions.maxDurationInDays. Both values range from 1 to 8 days.serviceResources lists the resource types the service requires, with 1 entry per type setting resourceType.id.primaryResourceType holds a resource type ID instead of staff members. Wix derives availability from the schedules of the resources in that type. Learn more about Wix Rentals availability.form.id is optional. On the services Wix Rentals creates it's the Wix Rentals default booking form, 3a2ea2ce-91f4-4617-ab24-629933c0c31a. Wix provisions that form when the app is installed, and its ID is identical on every site.payment.rateType is always FIXED. Learn more about pricing.A service supports a single unit type. To rent the same resource by the hour and by the day, create a separate service for each.
Services created by Wix Rentals don't appear in the Wix Bookings services list. They appear in the Wix Rentals section of the site dashboard.
Learn more about duration range services.
A rental costs more the longer a customer keeps it. Wix Rentals uses the Pricing API to charge a service's base price as a rate per unit of time, rather than a flat price per session. The rate is per hour for an hourly service and per day for a daily service. The final price is the base price multiplied by the number of units the customer books.
For an hourly service, Wix calculates the price at per-minute granularity, so a customer who books a partial hour pays a proportional amount. The price is the chosen duration in minutes multiplied by the base price divided by 60. On a service priced at $10 per hour, a 90-minute rental costs $15.
Because the price depends on the length of the rental, BookingLineItem also carries localStartDate, localEndDate, and timeZone. To show the customer an estimated price before creating the booking, call Preview Price with these fields. Learn more about how customers select a duration.
Wix Rentals stores reservations as bookings.
Rental bookings carry 2 additional read-only fields on bookedEntity.slot, which Wix populates only for services configured with a duration range:
durationUnitType: The booking unit, either HOUR or DAY.durationUnitCount: The booked duration. When durationUnitType is HOUR, this is a number of minutes, so a 2-hour rental has a durationUnitCount of 120. When durationUnitType is DAY, this is a number of days.Because both fields are read-only, don't set them when creating a booking. Wix derives them from the slot's start and end times.
The unit type and the resource's schedule determine how many bookings a reservation creates:
multiServiceBookingType set to SEQUENTIAL_BOOKINGS. A group holds between 2 and 8 bookings.Learn more about resource schedules and which of these paths applies.
For a multi-day rental on a 24/7 resource, Wix sets bookedEntity.slot.allDay to true on the resulting booking. Wix sets this field, so don't set it yourself. When it's true, startDate is midnight on the first day and endDate is midnight on the day after the last day, interpreted in the slot's time zone. A rental from Monday to Wednesday inclusive therefore ends at midnight on Thursday.
Rental bookings appear in the business calendar alongside other booking types. To retrieve them, filter by the Wix Rentals app ID, as described in Identify Wix Rentals entities in the API.
Wix Rentals creates and updates calendar events automatically as bookings change. A daily rental on a resource with working hours gets 1 event per day. An hourly rental gets a single timed event, and a daily rental on a 24/7 resource gets a single all-day event covering the full range.
Important: Don't interact directly with Calendar APIs to manage rental bookings. Use the Create Booking, Create Multi Service Booking, and Cancel Booking methods instead.
Resources can carry custom typed properties through the Bookings Attributes API. An attribute definition, such as string, number, or boolean, is created once per site, then per-resource values are set using the resource ID as the entityId.
For example, a vacation rentals business might define capacity as a number, bedType as a string, and hasWifias a boolean, then store per-room values that are displayed on the public site.
Wix Rentals uses the same Wix Forms integration as Wix Bookings. Provisioning creates the booking form under wix.rentals.form. Learn more about the Wix Bookings forms integration.
The Catalog Search API lets you query a site's service catalog and get back only the services that customers can book, each including availability data. In a single call, you can filter by business location, resource type, resource attributes, and an availability window.
To retrieve only rental services, specify the Wix Rentals app ID in the filter parameter, as described in Identify Wix Rentals entities in the API.
Catalog search complements the Time Slots V2 API used for Wix Rentals availability. Use catalog search to discover which rental services are available across the catalog, and Time Slots V2 to let the customer select a specific start and end time for a chosen service. Learn more about how catalog search matches an availability window for rentals.
Last updated: 31 August 2026