Skip to main content

Subscriptions model

The subscription model represents entitlements for an account: which plan applies, the subscription type, validity window, optional per-subscription dimensions, and linked products. In many stacks the same model holds opportunities, contracts, or deals as long as you map them to these properties.

Prerequisites

Field reference

Model keys

PropertyTypeDescription
subscription_idstringStable id for this subscription or contract row.
account_idstringAccount that holds the entitlement.

Default properties

PropertyTypeDescription
plan_idstringReferences a row in the plans model.
typestringSubscription category: typically free, trial, paid, poc, partner, or internal.
created_attimestampWhen the subscription record was created.
valid_fromtimestampStart of the entitlement window.
valid_untiltimestampEnd of the entitlement window (if applicable).
dimensionsjsonPer-subscription overrides to plan dimensions (same key semantics as plan dimensions).
productsjsonProduct linkage for multi-product contracts—align with Products product_id values where used.

Optional properties

PropertyTypeDescription
subscription_typestringAdditional subtype or commercial label from your source when distinct from type.

Custom-mapped fields may appear as extra properties for filtering or workflows.

Activities

Subscription models participate in subscription created and updated style activities for timelines when those rules are enabled.

Configure

  1. Add model → Subscription.
  2. Point at the connection that contains subscription, deal, or contract data.
  3. Map identifiers and dates; ensure account_id matches the accounts model.
  4. Serialize dimensions and products as JSON in the query result if those columns are not native JSON in the source.
  5. Validate, save, refresh, then check subscription details on accounts in the app.