PATCH
/api/v1/saas/subscriptions/:id/planUpgrade/downgrade a tenant subscription
Platform administrator requiredDeclared request fields: planCode (required).
SCREEN GUIDE · 11 OCT 2026
Tenant subscriptions
Review subscriptions and change an approved tenant plan.
OVERVIEW
What you can do
01
Subscription list
02
Current plan
03
Upgrade/downgrade
BEFORE YOU BEGIN
Access & setup
Intended access: Platform administrator.
- Platform administrator access.
- Choose the relevant school, academic session or child before working.
Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Locate the tenant subscription
Platform administrator access.
- 02
Review its current plan and state
Current plan is part of the documented workflow.
- 03
Apply the approved plan change and check usage implications
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
planCode | string | Required by declaration |
name | string | Required by declaration |
code | string | Required by declaration |
description | string | Optional |
billingCycle | string | Optional |
priceMonthly | number | Optional |
priceYearly | number | Optional |
trialDays | number | Optional |
maxStudents | number | Optional |
maxStaff | number | Optional |
maxSchools | number | Optional |
maxBranches | number | Optional |
isPublic | boolean | Optional |
isActive | boolean | Optional |
moduleKeys | string[] | Optional |
CURRENT BEHAVIOUR
Rules & current limits
- Platform access is distinct from a school role. Online SaaS invoice collection and invitation delivery require configured providers.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try tenant subscriptions
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
3 source-declared operations
GET
/api/v1/saas/plansList subscription plans with their modules
Platform administrator requiredPOST
/api/v1/saas/plansCreate a plan (with module toggles)
Platform administrator requiredDeclared request fields: name (required), code (required), description (optional), billingCycle (optional), priceMonthly (optional), priceYearly (optional), trialDays (optional), maxStudents (optional), maxStaff (optional), maxSchools (optional), maxBranches (optional), isPublic (optional), isActive (optional), moduleKeys (optional).
Open the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.