Plans model
The plan model defines the catalog of plans your customers can subscribe to: names, plan types, and default dimensions (limits and feature flags). Subscriptions reference plan_id to inherit those defaults; per-subscription dimensions can override plan defaults for entitlements and usage reporting.
Prerequisites
Plans are referenced by subscriptions. Configure accounts first, then plans before or alongside subscriptions so plan_id values resolve correctly.
Field reference
Model key
| Property | Type | Description |
|---|---|---|
plan_id | string | Stable identifier for the plan (SKU or internal id). |
Default properties
| Property | Type | Description |
|---|---|---|
name | string | Human-readable plan name. |
type | string | Plan category used in FunnelStory: typically one of free, trial, paid, poc, partner, or internal (align values with your billing system). |
dimensions | json | Default dimension map for this plan: keys are dimension names (for example seats, API units, feature flags); values are numeric limits or booleans as appropriate. These flow into subscription and usage analytics when subscriptions do not override them. |
Optional custom properties
You may map additional columns as custom properties for filtering or reporting where exposed.
Configure
- Configuration → Data models → Add model → Plan.
- Choose a warehouse, database, or CRM connection that holds plan definitions.
- Query one row per plan with
plan_id,name,type, anddimensions. - Validate JSON for
dimensionsmatches a JSON object shape. - Save and refresh.
Relationship to subscriptions and usage
- Each subscription row carries a
plan_idand optionaldimensions/productsoverrides—see Subscriptions. - Usage rows reference
dimensionnames that must align with keys in plan and subscription dimension maps—see Usage.