Kaiten
Core Concepts

Customers & Instances

How customers and instances model your SaaS deployments.

Customers & Instances

Customers

A Customer represents an end client of your SaaS product.

FieldDescription
nameCustomer display name
slugURL-safe identifier, unique per organization
external_customer_idOptional CRM reference (HubSpot, Salesforce, etc.)

Customers are org-scoped and can have one or more Instances.

Instances

An Instance represents a specific deployment of your SaaS product for a customer.

FieldDescription
nameInstance display name
slugURL-safe identifier, unique per organization
descriptionFree-form description
customer_idParent customer
license_idThe license governing this instance
deployment_zone_idOptional deployment zone (shared or dedicated)
platformOptional JSON metadata
metadataOptional JSON key-value pairs for custom instance data
start_license_dateLicense start date
end_license_dateLicense end date

The Core Chain

Organization
└── Customer: "Acme Corp"
    ├── Instance: "Acme Production" (License: Enterprise)
    └── Instance: "Acme Staging" (License: Development)

Each instance independently:

  • Has its own license (defining entitlements and quotas)
  • Can be assigned to a deployment zone
  • Has feature flags evaluated against it
  • Tracks entitlement usage separately
  • Has its own audit trail

Slugs

Every entity in Kaiten uses slugs — URL-safe identifiers that are unique within an organization. Slugs are used:

  • In REST API paths (e.g. GET /api/instances/acme-production)
  • In OFREP context variables (e.g. tenantSlug)
  • In the dashboard URLs

Slugs can be auto-generated from the name or explicitly set at creation time.

See It in the Console

The Console lets you manage customers and instances visually — create, edit, and explore their licenses, feature flags, entitlement usage, and audit trails.

On this page