TransaktDocs
Concepts

Products, editions and plans

How your catalogue is organised, and where capabilities live.

Your catalogue has three levels. Products and editions describe what you sell; plans describe how you sell it.

Product                 Planner
└── Edition             Basic · Business · Enterprise    (functional tier: capabilities and rank)
     └── Plan           Business monthly online · Business in Marketplace offer A · …    (commercial SKU)
          ├── Capability overrides (optional)
          └── Channels: Microsoft Marketplace listing, online prices (Revolut), direct

Product

What a customer buys: one of your applications, with its id (slug), names and descriptions in your languages, categories, logo and product types (web app, Teams app, SharePoint app, Office add-in, Power Platform solution).

Edition

A functional tier of a product, such as Basic, Business and Enterprise. An edition has:

  • an immutable slug, unique within the product, and translated names;
  • a rank (1, 2, 3, …; higher is a higher tier), which sets the upgrade and downgrade order;
  • the capabilities: the single source of truth for what the tier includes.

A product with one edition shows no edition vocabulary in the portals; you add a second edition when you start selling in tiers.

Plan

A commercial SKU of one edition: the edition sold through a channel, with a pricing model and a term. Every plan belongs to exactly one edition, so Business can be sold through two Marketplace offers and online, monthly and yearly, as several plans that share one capability set. A plan has:

  • a slug, names and an optional direct free trial;
  • a billing model: FlatRate (one price for the organisation) or PerUser (priced per licence; seats apply);
  • optional capability overrides: only keys that exist on its edition, of the same kind (for example a higher projects.max);
  • its channels: a Microsoft Marketplace listing, online prices, or neither (sold directly with subscription keys).

Capabilities: features and limits

Capabilities are named with dotted camelCase keys, at most 50 per edition:

KindValueExample
Featuretrue or falsereports.export: true
Limita whole number ≥ 0projects.max: 25

A plan's effective capabilities are its edition's, overlaid by the plan's overrides.

  • The entitlement answer reports the tenant's features as a map of switches, combined over its active plans (on if any active plan has it on).
  • The catalogue reports every plan's effective capabilities, features and limits, with its edition. Read a limit from the plan (or plans) the entitlement names.
  • The key marketplace.perUser is echoed from the plan's billing model for older applications; prefer licenceModel.

Upgrades and downgrades

A plan change is an upgrade when the target plan's edition ranks higher, a downgrade when it ranks lower, and lateral within the same edition (another term or offer). Online upgrades apply at once with a prorated charge; online downgrades apply at the end of the period. Moving a plan to another edition changes what its subscriptions report from the next entitlement read; it sends no webhook event.

On this page