Editions & Plans
Define, manage, and version your SaaS product plans using SCRIPE's powerful Editions engine.
Editions are the building blocks of your SaaS pricing strategy. Each edition bundles a specific set of feature values (Boolean toggles, numeric limits, string configurations) into a named plan that can be assigned to tenants via subscriptions.
What Are Editions?
An Edition is a named plan (e.g., 'Basic', 'Pro', 'Enterprise') that defines a specific combination of feature values. When a tenant subscribes to an edition, they automatically gain access to exactly the features that edition defines — not more, not less.
{
"name": "Pro",
"scope": "System",
"isDefault": false,
"overflowEditionId": "enterprise-id",
"features": [
{ "feature": "MaxUsers", "value": "50" },
{ "feature": "ApiAccess", "value": "true" },
{ "feature": "StorageGB", "value": "100" },
{ "feature": "CustomDomain", "value": "true" },
{ "feature": "Priority", "value": "Standard" }
]
}System vs Retail Editions
| Scope | Created By | Use Case |
|---|---|---|
| System | Platform owner (root tenant) | Global plans available to all tenants (Basic, Pro, Enterprise) |
| Retail | Reseller tenants | Custom plans for child tenants (white-label reselling) |
Overflow Policies
When a tenant exceeds their edition's limits, the overflow policy determines the behavior. This creates natural upsell paths without breaking the user experience.
Suggest Upgrade
When limits are reached, the system returns an upgrade suggestion pointing to the overflow edition — creating a seamless upsell path.
Hard Block
Strictly enforce the limit. Commands are rejected with a clear error message indicating the feature is at capacity for the current plan.
Versioning & Rollouts
Edition versions allow you to modify plan features without disrupting existing subscribers. Create a new version with updated feature values, then choose your rollout strategy.
| Strategy | Behavior | Best For |
|---|---|---|
| Immediate | All subscribed tenants updated instantly | Bug fixes, security patches |
| Canary | Percentage-based gradual rollout | Feature experiments, risk mitigation |
| Scheduled | Deploy at a specific date/time | Aligned product launches, billing cycles |
API Endpoints
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/editions | List all editions | 🔒 Required |
| POST | /api/editions | Create new edition | 🔒 Required |
| PUT | /api/editions/{id} | Update edition | 🔒 Required |
| DELETE | /api/editions/{id} | Delete edition | 🔒 Required |
| POST | /api/editions/{id}/features | Set edition features | 🔒 Required |
| POST | /api/editions/{id}/versions | Create edition version | 🔒 Required |
| POST | /api/editions/{id}/versions/{vId}/apply | Apply version (rollout) | 🔒 Required |