Documentation

Welcome to the Periode documentation. Use the menu on the left to open a guide, or use search to jump straight to a section.

Backoffice

Guides for setting up and running Periode from the merchant side.

• Start here explains the platform concepts, the launch checklist, and the difference between products, sessions, customers, payments, and reports.
• Account and settings covers organization details, admin users, restricted booking access, customer accounts, login methods, and payment setup pointers.
• Payments and refunds covers how payments move through Periode, refund behaviour, and failed payments.
• Booking products covers product setup: schedules, capacity, prices, discounts, waivers, booking groups, named sessions, optional extras, and access codes.
• Booking calendar covers day-to-day calendar operations: check-in, admin bookings, rescheduling, cancellations, reservations, messages, and live session changes.
• Subscriptions and memberships covers recurring products, discounts, gift subscriptions, pausing, ending, billing and renewals, failed payments, refer a friend, and subscriber management.
• Gift cards covers selling, issuing, finding, redeeming, and adjusting balances for gift cards.
• Punch passes covers clip cards, included sessions, personal and non-personal passes, membership-granted passes, redemption, and support.
• Branding covers the look of customer pages and emails: logo, colours, background, fonts, top bar, product presentation, and previewing.
• Reporting covers monthly reports, sales exports, booking statistics, payment overview, gift card reports, and payout reconciliation.
• Customer experience explains what customers see when they book, buy memberships, use discounts, redeem gift cards, and manage their account, and why account identity matters.
• Operational playbooks gives practical workflows for running front of house, handling closures and seasonal changes, and routine checks.
• Chargebacks, fraud and notifications explains the notifications under Home, where to find the Adyen disputes list, and what to do about fraud alerts and chargebacks.
• Periode fees and invoices explains what is deducted from Adyen payments, what the monthly invoice contains, how VAT and SMS are charged, and how accounts that are not on Adyen yet are invoiced.
• FAQ and troubleshooting keeps support-style answers for common customer, booking, membership, payment, and access-code issues.

Technical

For developers building on top of Periode.

• Getting started covers the API base URL, your API key, a connectivity test, and shared conventions.
• Integrations guide covers managing products, admin invites, and door locks through the Merchant API.
• Booking API covers availability, booking products, bookings, check-in, and door pincodes.
• Webhooks covers booking and subscription webhooks, payloads, and testing.
• GA4 and Meta tracking covers connecting analytics, preserving campaign attribution, and embedding the booking flow.
• API payment flow covers redirect-and-webhook payment flows where your own system owns the customer journey.