Skip to content

MODULE GUIDE · 11 OCT 2026

Platform administration

Manage tenants, schools, plans, subscriptions, billing and cross-tenant reporting.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

01

Tenant onboarding

02

Schools and quotas

03

Plans and module toggles

04

Subscriptions

05

Invoices and coupons

06

Analytics and reports

07

Usage

08

Audit and support

BEFORE YOU BEGIN

Access & setup

Intended access: Platform administrator.

A platform administrator account.
The academic, student or staff setup used by this workflow.

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
Select the tenant or platform overview
A platform administrator account.
02
Review plan, subscription, usage and school details
Schools and quotas is part of the documented workflow.
03
Apply an authorized administrative action
Plans and module toggles is part of the documented workflow.
04
Review the resulting invoice, audit or report
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
`code`	string	Required by declaration
`description`	string	Optional
`type`	string	Optional
`value`	number	Required by declaration
`maxRedemptions`	number	Optional
`validFrom`	string	Optional
`validUntil`	string	Optional
`isActive`	boolean	Optional
`question`	string	Required by declaration
`planCode`	string	Optional
`amount`	number	Optional
`paymentLogId`	string	Required by declaration
`razorpayPaymentId`	string	Optional
`razorpaySignature`	string	Optional
`name`	string	Required by declaration
`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

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

Try platform administration

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →

FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

43 source-declared operations

GET/api/v1/saas/coupons

List discount codes with their redemption counts

Platform administrator required

POST/api/v1/saas/coupons

Issue a discount code

Platform administrator required

Declared request fields: code (required), description (optional), type (required), value (required), maxRedemptions (optional), validFrom (optional), validUntil (optional), isActive (optional).

PATCH/api/v1/saas/coupons/:id

Change a code’s window, cap or active flag

Platform administrator required

Declared request fields: code (optional).

GET/api/v1/saas/coupons/preview/:code

What a code would do to an invoice, without spending it

Platform administrator required

POST/api/v1/saas/coupons/invoices/:invoiceId/apply

Apply a code to an invoice and spend one redemption

Platform administrator required

Declared request fields: code (required).

DELETE/api/v1/saas/coupons/invoices/:invoiceId

Take the code back off an invoice

Platform administrator required

POST/api/v1/saas/ai-center/ask

Ask a plain-English question about the platform — answered from real, computed aggregates

Platform administrator required

Declared request fields: question (required).

GET/api/v1/saas/analytics

Cross-tenant growth/revenue/churn analytics with an AI-generated narrative summary

Platform administrator required

GET/api/v1/saas/audit-log

Platform activity trail — every superadmin action across every tenant

Platform administrator required

GET/api/v1/saas/subscriptions

List subscriptions across all tenants

Platform administrator required

PATCH/api/v1/saas/subscriptions/:id/plan

Upgrade/downgrade a tenant subscription

Platform administrator required

Declared request fields: planCode (required).

GET/api/v1/saas/invoices

List SaaS invoices

Platform administrator required

GET/api/v1/saas/invoices/:id

Invoice

Platform administrator required

POST/api/v1/saas/invoices/:id/payment-order

Create a Razorpay order to collect payment against an invoice

Platform administrator required

Declared request fields: amount (optional).

POST/api/v1/saas/payments/verify

Verify a Razorpay payment callback and mark the invoice paid

Platform administrator required

Declared request fields: paymentLogId (required), razorpayPaymentId (optional), razorpaySignature (optional).

GET/api/v1/saas/payments/test-connection

Check whether configured Razorpay credentials actually authenticate

Platform administrator required

GET/api/v1/saas/overview

Platform KPIs (tenants, footprint, MRR/ARR, billing)

Platform administrator required

GET/api/v1/saas/modules

List all toggleable platform modules

Platform administrator required

GET/api/v1/saas/plans

List subscription plans with their modules

Platform administrator required

GET/api/v1/saas/plans/:id

Get One

Platform administrator required

POST/api/v1/saas/plans

Create a plan (with module toggles)

Platform administrator required

Declared 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).

PATCH/api/v1/saas/plans/:id

Update

Platform administrator required

DELETE/api/v1/saas/plans/:id

Soft-delete (archive) a plan

Platform administrator required

GET/api/v1/saas/reports/:type

Cross-tenant report (revenue/usage/churn/activity) as JSON, CSV, or PDF

Platform administrator required

GET/api/v1/saas/tenants

List tenants (search, status filter, paginated)

Platform administrator required

GET/api/v1/saas/tenants/:id

Tenant detail with schools, subscription and counts

Platform administrator required

POST/api/v1/saas/tenants

Onboard a new tenant/school (provisions admin + plan)

Platform administrator required

Declared request fields: tenantName (required), slug (required), schoolName (required), schoolCode (required), board (optional), type (optional), adminEmail (required), adminPassword (required), adminFirstName (required), adminLastName (optional), planCode (optional).

POST/api/v1/saas/tenants/:id/schools

Add a school to an existing tenant (counts against the plan)

Platform administrator required

Declared request fields: code (required), name (required), type (optional), board (optional), adminEmail (optional), adminPassword (optional), adminFirstName (optional), adminLastName (optional).

POST/api/v1/saas/tenants/ai-provision

AI Command Center — provision a full tenant from just school/owner facts and email the owner their access

Platform administrator required

Declared request fields: schoolName (required), institutionType (required), ownerName (required), ownerEmail (required), ownerPhone (optional), domain (optional).

PATCH/api/v1/saas/tenants/:id/status

Activate / suspend / cancel a tenant

Platform administrator required

Declared request fields: status (required).

POST/api/v1/saas/tenants/bulk-action

Apply activate/suspend/cancel to multiple tenants at once

Platform administrator required

Declared request fields: ids (required), action (required).

GET/api/v1/saas/tenants/health/scores

Composite health score per tenant (status, overdue invoices, login recency, trial runway)

Platform administrator required

PATCH/api/v1/saas/tenants/:id/branding

Update white-label branding (brand name, color, custom domain)

Platform administrator required

Declared request fields: brandName (optional), primaryColor (optional), faviconUrl (optional).

POST/api/v1/saas/tenants/:id/logo

Upload the tenant logo

Platform administrator required

POST/api/v1/saas/tenants/:id/favicon

Upload the tenant favicon

Platform administrator required

POST/api/v1/saas/tenants/:id/domain

Claim a custom domain — returns a DNS TXT record to publish for ownership proof

Platform administrator required

Declared request fields: domain (required).

DELETE/api/v1/saas/tenants/:id/domain

Remove the custom domain and reset verification

Platform administrator required

POST/api/v1/saas/tenants/:id/domain/verify

Verify domain ownership via a real DNS TXT lookup

Platform administrator required

GET/api/v1/saas/usage

Every tenant against its plan limits

Platform administrator required

GET/api/v1/saas/usage/:tenantId

Status

Platform administrator required

GET/api/v1/saas/usage/:tenantId/counters

Counters

Platform administrator required

POST/api/v1/saas/usage/:tenantId/refresh

Recount usage and write this period's counters

Platform administrator required

GET/api/v1/my-plan/usage

This tenant's usage against its own plan

Authenticated scope and endpoint-specific rules

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/saas/ai-centerOpen ↗/en/saas/analyticsOpen ↗/en/saas/audit-logOpen ↗/en/saas/command-centerOpen ↗/en/saas/couponsOpen ↗/en/saas/invoicesOpen ↗/en/saas/invoices/[id]Open ↗/en/saasOpen ↗/en/saas/plansOpen ↗/en/saas/reportsOpen ↗/en/saas/subscriptionsOpen ↗/en/saas/tenantsOpen ↗/en/saas/tenants/[id]Open ↗/en/saas/usageOpen ↗/en/school/planOpen ↗

Keep exploring