Scale Intelligence■ Docs
Docs / The model / SubscriptionPlan

SubscriptionPlan.

The limits a tenant receives, each a parameter of the receive family, and its kind: trial, paid or internal; acquisition never reads it

Figure 1SubscriptionPlanspecified
SUBSCRIPTIONPLANdefinition at tenant scopenametextthe tenant the plan limits; absent on a plan embedded in a tenant's row at sign-uptenantidoptionalenforced at delivery, counted across the tenant's brandsleads_per_periodcountperioddurationdefinitions_armedcountoptionalstarts_attimeends_attimeoptionalkindenum:trial|paid|internala trial's endendsdateoptionalpoints at no other object
SubscriptionPlan is a definition at tenant scope. The drawing shows its fields and the objects that they point at.
kind
definition
scope
tenant
key
the tenant and its dates
store
postgres
family
people

Fields#

fieldtyperequirednote
nametextyes
tenantidnothe tenant the plan limits; absent on a plan embedded in a tenant’s row at sign-up
leads_per_periodcountyesenforced at delivery, counted across the tenant’s brands
perioddurationyes
definitions_armedcountno
starts_attimeyes
ends_attimeno
kindone of trial | paid | internalyes
endsdatenoa trial’s end

Routes that use it#

No route takes or returns SubscriptionPlan directly. The record holds it, and the objects that point at it reach it.