Shumoul Subscription Packages & Entitlements — Developer Guide
How Shumoul subscription packages, features, settings-group entitlements, report entitlements, and package limits fit together — and the four Shumoul-branded customer packages (Starter, POS, Finance Starter, Finance Advanced) built on this architecture to exercise the full signup → onboarding → entitlement → Starter Kit journey for real, realistic package tiers.
Who it's for: Backend Developers · Product/Commercial (package design) · QA · Future Maintainers
| Field | Value |
|---|---|
| Status | Production Ready (backend) — package rules are seeded, queryable, and enforced (see Chapter 13) |
| Version | Shumoul.Framework.MultiTenancy.Api 1.0.124 |
| Last Updated | 2026-07-20 (Chapter 18 — AppSettings group-aware key lookup fix) |
| Maintained By | Shumoul Engineering |
| Documentation | Official Developer Guide |
| Source of Truth | Shumoul Platform Source Code (Shumoul.Saas.MultiTenancyApi, Shumoul.Saas.Api) |
Chapters
| # | Section | File |
|---|---|---|
| 1 | Cover | 01-cover.md |
| 2 | Table of Contents | 02-table-of-contents.md |
| 3 | Architecture — Real Entity and Table Names | 03-architecture.md |
| 4 | Seed Architecture and the SeedHistory Gotcha | 04-seed-architecture.md |
| 5 | Package Blueprints — the Four Shumoul Packages | 05-package-blueprints.md |
| 6 | Permission Safety — No Platform/Root-Admin Leakage | 06-permission-safety.md |
| 7 | Package Rules and Limits | 07-package-rules-and-limits.md |
| 8 | Report Entitlements | 08-report-entitlements.md |
| 9 | Onboarding and Settings Entitlement Behavior | 09-onboarding-entitlement-behavior.md |
| 10 | Starter Kit Behavior | 10-starter-kit-behavior.md |
| 11 | Testing and Live Verification | 11-testing-and-verification.md |
| 12 | Production Readiness and Adding Future Packages Safely | 12-production-readiness.md |
| 13 | Package Limit Enforcement | 13-package-limit-enforcement.md |
| 14 | Package Scenario QA Matrix | 14-package-scenario-qa-matrix.md |
| 15 | Production / Staging Deployment Verification | 15-production-deployment-verification.md |
| 16 | Dev/Staging Subscription Remediation & Entitlement Verification | 16-dev-staging-subscription-remediation.md |
| 17 | Tenant-Isolated AppSettings Caching | 17-tenant-isolated-appsettings-caching.md |
| 18 | AppSettings Group-Aware Key Lookup | 18-appsettings-group-aware-key-lookup.md |