Technical Documentation | SCRIPE Docs Portal

Technical Commercial Ops

Overview Prerequisites Quick Start Project Structure

Architecture Overview Backend Architecture Frontend Architecture CQRS Pattern Module System SOLID View/ViewModel State Management Data Flow Domain Model Domain Events CQRS Pipeline Dependency Injection Cross-Module Collaboration Deep Dive

Authentication Auth Sessions & Token Management User Management Roles & Permissions Access Control Deep Dive User Groups Multi-Tenancy Tenant Context Gate Enterprise SSO Architecture (Federation & Keycloak Alternative)SSO & Identity Providers Self-Service Signup & B2B2C Onboarding Authentication Deep Dive

Login Customizer Studio Login Page Builder Multi-Page Branding Theme Marketplace Dashboard Builder Dashboard Hub (Hub-and-Spoke)Menu System

Venue & Facilities Operations Schedulable Resources & Composite Trees Availability Engine & Interval Trees Booking Workspace & 2-Phase Holds Operations Calendar & Dispatch Grid Reservation 360 & Lifecycle Engine Attention Center & Exception Sweeper Facility Management & Geometry

Catalog & Dynamic Pricing Engine Rate Cards & Multi-Currency Matrices Dynamic Pricing Rules & Surcharges Cryptographic Price Quotes & Checkouts

Finance & Payment Settlement Double-Entry Ledger & Chart of Accounts Customer Invoices & Payment Tracking Multi-Party Settlements & Split Payouts

Entitlements Overview Editions Subscriptions Features Feature Overrides CRM Leads Billing Engine Invoices & Revenue Dunning System Tenant Plans User Subscriptions Revenue Analytics Engine Stripe Connect Signup Customization Platform Management

HRMS & Workforce Management Staff Directory & Competency Frameworks Shift Scheduling & Availability Matrices Certifications & Compliance Tracking

Party Kernel & Polymorphic Directory Polymorphic Party Model Party Relationship Graph Party Deduplication & Merge Engine

Organization Core & Hierarchy Multi-Tier Organization Tree Cross-Branch Governance & Delegation

Digital Asset & Media Management File Upload System Download & Export System File Storage Media Module

Omnichannel Communication & Dispatch Notification System Email System Message Templates Communication Module

Developer Integrations & API Gateway Webhook System Webhooks Integrations Module

Custom Fields Module Custom Fields Value Types Reference Fields Reference Lookups Defining a Field Field Groups Options Option Sets Validators Field-Level Security Cryptographic Key Management & Envelope Encryption Managing Fields Limits and Behaviours

Work Management Module Work Items & Custom Field Schemas Kanban Boards & Workflows SLA Policies & Escalation

Analytics Event Foundation Audit Logs Security Monitoring

Compliance Module Data Subject Rights (DSR)Consent Management Data Retention Policies Data Inventory Compliance Reports Regulation Profiles

Plugin System Overview Plugin SDK Reference Plugin Definition & Versioning Plugin Installation & Security Plugin Runtime & Data

Marketplace Overview App Listings & Screenshots Developer Portal App Purchases & Analytics Ratings & Reviews Marketplace

Recycle Bin Recycle Bin

Security Overview Middleware Pipeline API Security Data Protection Audit & Compliance

Enterprise Platform Configuration (appsettings.json)Background Jobs Resilience Patterns Gateway & Deployment Enterprise Database Migrations SCRIPE CLI Tooling Health Checks & K8s Probes Observability & Monitoring Enterprise Audit Trail Load Testing & Backup Cache Invalidation Outbox Pattern Shared Idempotency and Search Foundations

CRUD System State Management Localization (i18n)Form Validation Component Library Real-Time (SignalR)

API Reference Authentication API (Admin)User Authentication API Admin Management API Tenant Management API Role & Permission API User Groups API Webhook, Email & Notification API System API

Add a Frontend Module Add a Backend Module Developer Setup to Enterprise Onboarding Venue Hierarchy & Concurrent Booking Dynamic Pricing & Double-Entry Accounting Workforce Rostering & Customer 360 Extending SCRIPE: Custom Fields & Marketplace Plugins Enterprise Governance, Compliance & Analytics

Page not found

We couldn't find /docs/rest-api-overview.