Architecture
browser -> starter + SDK -> saas_core (HTTP API, webhooks) -> fcctl -> Frappe Cloud
^
payment gateway callbacks- Frontends talk only to the
saas_coreHTTP API (versioned OpenAPI contract, API2.0.0-alpha.1). The starter and the TypeScript SDK (@frappe-saaskit/client,react,mock) are one such frontend. saas_coreruns on one “control plane” Frappe site. It owns plans, templates, tenants, subscriptions, billing and provisioning jobs.- Pay then provision: checkout creates a pending Tenant; the gateway callback or webhook is stored once as a Payment Event; the processor activates the Subscription; the first success enqueues a
provisionjob that drivesfcctland emails the owner a one-time setup link. Jobs are auditable and resume-safe. fcctlis the only thing that talks to Frappe Cloud. It restores a golden backup into a new site, runs hooks and health checks.- Tenant sites are separate Frappe sites, one per customer, created on Frappe Cloud.
- Recipes are how your own app plugs in. See Writing a recipe.
What the customer sees


Mock modes
| Mode | Where | What it does |
|---|---|---|
| Fixture mode | starter | In-memory demo data, no backend |
@frappe-saaskit/mock | SDK | Mock client for tests and UI work |
saas_core_fake_fcctl=1 | saas_core site_config | In-memory fake instead of Frappe Cloud |
fcctl.testing.FakeFrappeCloud | fcctl | Fake Frappe Cloud for tests |
saas_core_local_bench | saas_core | Experimental: real sites on the same bench |
Authoritative diagrams and contracts: saas_core docs/ARCHITECTURE.md .
Use at your own risk. Frappe SaaS is early alpha software, provided “as is” without warranty of any kind. We are not accepting pull requests or outside contributions. If you find a problem, please file an issue on saas_core , or on the docs repo for mistakes in these pages.
Last updated on