Skip to content
KahunaCart

Powered by Grav CMS + Helios Theme

Settings reference

Manage plugin settings under Plugins → KahunaCart Rentals or in user/config/plugins/kahunacart-rentals.yaml.

The plugin settings control whether Rentals is enabled and when messages are sent. Configure arrival times, stay limits, prices, fees and payment terms on each property’s booking rule.

Before you begin

  • kahunacart.settings to open the form and save it.
  • A text editor and a deploy step, if you would rather write the YAML.

Configuration keys

Setting Key Default Range What it does
Plugin status enabled on — Whether the nightly way of booking is registered at all
Ask for the balance this many days early balance_reminder_days 3 0–60 How many days early the guest is asked for the balance
Send the arrival note this many days ahead pre_arrival_days 3 1–60 How many days before arrival the note with the directions goes out
Send the thank-you this many days after they leave thank_you_days 1 0–30 How many days after departure the thank-you follows

balance_reminder_days: balance reminder timing

balance_reminder_days sets when KahunaCart’s balance-due email is sent before the deadline. That core email contains the payment link; Rentals does not add a separate notification switch for it.

A value of zero sends the reminder on the due date. The default is three days, giving guests time to arrange payment before it becomes overdue.

Reminder timing does not trigger automatic cancellation, release dates or transfer money.

pre_arrival_days and thank_you_days: stay message timing

Enable or disable each message under KahunaCart → Settings → Notifications. The timing values do not control whether it is sent.

pre_arrival_days has a minimum of 1 and cannot be zero.

Set thank_you_days to 0 to send on the departure day. The default is the following day.

Write arrival instructions on each property. See The two messages for delivery rules and access-instruction privacy.

Disable Rentals

Set enabled to false to stop offering nightly stays. Existing properties and bookings remain. The picker and cart reject new stays with Nightly stays come with the KahunaCart Rentals add-on. Re-enable the plugin to offer nights again.

Property settings

Configure the following values separately for each property.

Set these fields on the product’s booking rule in Bookings → Services:

What Where it is
How it is booked, set to Nightly stay Bookings' service row
It sleeps — the ceiling on guests Bookings' service row (party_size)
Which bookable it occupies, and how many of it there are Bookings' needs and bookables
Its hours and its days off Bookings' schedules
Notice and how far ahead, read as hours and days Bookings' service row
Whether it is paid for online or on arrival Bookings' service row

The Nightly stay panel adds these fields to the same form:

What Default
Check in from 16:00
Check out by 10:00
Shortest stay 1 night
Longest stay 28 nights. Zero is no limit
Arrival days and departure days Nothing ticked, meaning any day
How many guests the nightly rate covers 2
What each guest over that costs, per night none
Cleaning fee, once a stay none
Damage deposit, a stated amount the store never charges none
Whether to avoid stranding nights on
Deposit percentage empty, meaning the whole amount at checkout
Days before arrival the balance is due empty, meaning midnight on the day they arrive
The cancellation policy, as steps none
Arrival instructions empty

Set these values on each property so its check-in times, stay limits, fees and payment terms can differ from other properties in the store.

Press Save once to store the booking rule and rental rules in one transaction. Invalid combinations are rejected without saving partial changes.

Manage rate bands in the Rates tab, available when the store has a nightly property. See Rates and seasons.

Hours

Assign an all-day schedule with 00:00 to 24:00 on every weekday. bin/plugin kahunacart-rentals seed rental creates an Always open schedule that properties can share.

A property with no applicable hours is closed. Every night reports blackout. Check its schedule first when the calendar shows no availability.

Use schedule date overrides for seasonal closures. See Opening hours.

Timezones

Nights use the property’s timezone, then its schedule’s timezone, then the store’s. A Florida property uses Florida dates even if the shop is based in Denver.

If a requirement includes several bookables in different timezones, the first bookable’s timezone is used before resource selection. Use one property per requirement when properties need different local dates.

The seeds write everything in the store's own timezone unless --timezone says otherwise.

Currency

Amounts are stored in minor units, such as cents or yen, and CLI output uses the same formatter as receipts. A property is priced in the store's base currency and, on a store that sells in more than one currency, in each of the others too. See Selling in more than one currency.

Complete configuration file

YAML
enabled: true

balance_reminder_days: 3

pre_arrival_days: 3

thank_you_days: 1

enabled is Grav’s plugin switch. Disabling it stops new nightly bookings while retaining properties, rules and rate cards.