Skip to main content

Tenant Concepts

Summary

Platform uses related control-plane concepts rather than a single tenant record for every concern. This page defines only concepts confirmed in source.

Audience

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

Purpose

Use these definitions when designing integrations, reviewing tenant changes, or interpreting administration and provisioning state.

Architecture

This is a conceptual relationship diagram, not a database schema.

Business concepts

ConceptPurpose and ownershipRelationships and lifecycle relevanceStatus
TenantPlatform-owned configuration root with stable platform identity, tenant key, name, and statusLinks control-plane records and anchors tenant-scoped administrationImplemented
Tenant keyHuman-meaningful tenant identity used for lookup and contextUniqueness is validated during creation and provisioningImplemented
Platform clientCustomer/control-plane record associated with tenant registration and commercial setupLinks subscriptions, licenses, entitlements, branding, and provisioning requestsImplemented; Transitional overlap with Tenant
CompanyTenant-owned legal, display, contact, locale, and regional profileCreated or updated during administration and provisioningImplemented
Tenant metadataStatus, identifiers, domain state, settings, audit, and timeline informationChanges across onboarding and operationsImplemented
BrandingClient-linked visual and email presentation metadataEstablished during provisioning and mutable through administrationImplemented
ConfigurationPlatform, service, or tenant-scoped settings and secret referencesSupports defaults and tenant-level values without publishing secretsFoundation / Implemented records
PlanVersionable commercial package definition with configured features and limitsSelected by subscriptionsImplemented
SubscriptionTenant/client association with a plan and lifecycle stateDrives plan-derived feature access and commercial timingImplemented
LicenseClient or tenant validity and capacity recordEvaluated with usage and grace state; related but distinct from packagingImplemented; multiple models are Transitional
Feature entitlementPlan inclusion or tenant-specific grant/deny/valueEvaluated against tenant and subscription stateImplemented
Feature flagTenant-scoped runtime on/off recordMaterialized independently from catalog packagingImplemented
ModuleTenant-scoped module enablement or catalog groupingDerived or reconciled from effective accessImplemented; model overlap is Transitional
Usage and billingMetering, charge, invoice, payment, and limit recordsRelates subscriptions and licenses to reported consumptionFoundation / Implemented records and endpoints

Technical implementation

The platform persistence context contains these aggregates and endpoint groups read or mutate them. Because Tenant and Platform Client, Client License and enterprise License, and catalog versus runtime feature records coexist, integrations should use the owning endpoint contract rather than treating similarly named concepts as interchangeable.

Source References

  • microservices/src/platform-service/Data/PlatformDbContext.cs
  • microservices/src/platform-service/Domain/Entities/Tenant.cs
  • microservices/src/platform-service/Domain/Entities/PlatformClient.cs
  • microservices/src/platform-service/Domain/Entities/Company.cs
  • microservices/src/platform-service/Domain/Entities/Plan.cs
  • microservices/src/platform-service/Domain/Entities/Subscription.cs
  • microservices/src/platform-service/Domain/Entities/License.cs
  • microservices/src/platform-service/Domain/Entities/Feature.cs
  • microservices/src/platform-service/Domain/Entities/TenantFeature.cs
  • microservices/src/platform-service/Domain/Entities/TenantBranding.cs

See Also

Keywords

  • Tenant identity
  • Platform client
  • Commercial relationship
  • Runtime controls

Revision Information

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