Skip to main content

Plans and Subscriptions

Summary​

Plans define versioned commercial packages; subscriptions associate a platform client with a plan and retain commercial snapshots and lifecycle dates. Source supports usage, charge, invoice, and payment records, but does not by itself approve external commercial policy.

Audience​

  • Platform and customer administrators
  • Implementation partners, developers, architects, and product owners

Purpose​

This page separates package definition, tenant subscription state, metered usage, and billing records from license validity and runtime access evaluation.

Architecture​

Business concepts​

  • Plan — Implemented: a named/versioned definition can carry configured prices, billing-cycle metadata, trial/grace metadata, limits, modules, features, and effective dates.
  • Plan feature — Implemented: connects a catalog feature or limit with plan inclusion and an optional value.
  • Subscription — Implemented: connects a platform client to a plan and preserves plan/limit snapshots plus start, end, trial, grace, renewal, cancellation, and scheduled-change metadata.
  • Lifecycle — Implemented: source exposes assignment, trial start, activation, renewal, scheduled plan change/application, suspension, resumption, cancellation, and expiring-subscription queries.
  • Usage — Implemented foundation: usage can be recorded and compared with configured limits.
  • Commercial records — Implemented foundation: charge, invoice, line, payment, and billing-summary operations exist.
  • Policy — Requires confirmation: approved billing frequencies, currencies, price books, taxation, proration, invoice issuance rules, and collection policy are not established here.

Technical implementation​

Commercial endpoints validate referenced records and persist lifecycle transitions. Entitlement resolution selects a current subscription from active lifecycle states and reads its plan features. Because status and timing fields coexist, clients should consume endpoint results rather than infer commercial rules.

Source References​

  • microservices/src/platform-service/Api/PlatformCommercialEndpoints.cs
  • microservices/src/platform-service/Domain/Entities/Plan.cs
  • microservices/src/platform-service/Domain/Entities/PlanFeature.cs
  • microservices/src/platform-service/Domain/Entities/Subscription.cs
  • microservices/src/platform-service/Data/PlatformDbContext.cs
  • microservices/src/platform-service/Api/PlatformEntitlementEndpoints.cs

See Also​

Keywords​

  • Commercial packaging
  • Subscription lifecycle
  • Usage records
  • Billing foundation

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-14
  • Review cycle: Quarterly