Collections

Schemas for all five collections created by the plugin.

Services

Slug: services

Defines what can be booked (e.g., "Haircut", "Consultation", "Massage").

await payload.create({
  collection: 'services',
  data: {
    name: 'Haircut',
    duration: 30,
    durationType: 'fixed',
    price: 35.00,
    bufferTimeBefore: 5,
    bufferTimeAfter: 10,
    active: true,
  },
})

See Booking Features → Duration Types for how durationType affects end time calculation.

Resources

Slug: resources

Who or what performs the service (a stylist, a room, a machine, a yoga instructor).

await payload.create({
  collection: 'resources',
  data: {
    name: 'Room 101',
    services: [conferenceServiceId],
    quantity: 1,
    active: true,
  },
})

See Booking Features → Capacity and Inventory for how quantity and capacityMode work together.

Schedules

Slug: schedules

Defines when a resource is available. Supports recurring (weekly pattern) and manual (specific dates) types, plus exception dates.

Times use HH:mm format (24-hour, e.g., 09:00, 17:30). The format is validated — values like 9:00 (missing leading zero) or 09:00:00 (with seconds) are rejected. Within each slot, endTime must be after startTime. Any date inside an exception (including a date–endDate range, where endDate must be on or after date) blocks out that entire day.

await payload.create({
  collection: 'schedules',
  data: {
    name: 'Alice - Standard Week',
    resource: aliceId,
    scheduleType: 'recurring',
    recurringSlots: [
      { day: 'mon', startTime: '09:00', endTime: '17:00' },
      { day: 'tue', startTime: '09:00', endTime: '17:00' },
      { day: 'wed', startTime: '09:00', endTime: '17:00' },
      { day: 'thu', startTime: '09:00', endTime: '17:00' },
      { day: 'fri', startTime: '09:00', endTime: '15:00' },
    ],
    exceptions: [
      { date: '2025-12-25', reason: 'Christmas', type: 'closure' },
      // A multi-day range (inclusive): the resource is off all week
      { date: '2025-07-01', endDate: '2025-07-07', reason: 'Vacation', type: 'vacation' },
    ],
    active: true,
  },
})

Customers

Slug: customers (or your userCollection slug)

Either a standalone auth collection (default) or fields injected into your existing auth collection when userCollection is set.

Standalone Mode (default)

A dedicated auth collection with auth: true for customer JWT login. Has access.admin: () => false to block customers from the admin panel.

User Collection Mode (userCollection set)

The plugin injects name, phone, notes, and a bookings join field into your existing auth collection. No new collection is created. The resolved slugs.customers points at the user collection so all downstream code uses the correct slug.

Field deduplication prevents double-injection — the plugin checks each field's name before injecting, so if your collection already defines name (or any of the others) the existing field config wins.

Fields

Reservations

Slug: reservations

The core booking records. Each reservation links a service performed by a resource to either a registered customer or an anonymous guest.

A reservation must have either a customer or a guest — not both, not neither (enforced by the validateGuestBooking hook, gated by allowGuestBooking). See Booking Features → Multi-Resource Bookings for the items array and Booking Features → Guest Bookings for account-less bookings.