Skip to main content

Interface: CustomerSetup

Customer account identity and status information.

CustomerSetup contains the core identification and operational status information for a customer account. It provides the fundamental identity properties that distinguish this customer within the system and control its operational state.

Extends​

Extended by​

Properties​

allowInvites?​

optional allowInvites: boolean

Controls whether this customer can invite new users.

When true, administrators for this customer can send invitations to new users, allowing them to expand their team. This capability can be restricted based on licensing limits or administrative policies.

customerId​

customerId: string

Unique identifier for this customer account.

This ID uniquely identifies the customer throughout the system and is used as the primary key for database operations and API calls. All customer data and configurations are associated with this identifier.

Inherited from​

CustomerGeneric.customerId

customerName?​

optional customerName: string

Official registered name of the customer organization.

This is the formal name of the customer entity as registered in business systems. It serves as the default display name when no display name is specified.

Inherited from​

CustomerGeneric.customerName

displayName?​

optional displayName: string

Optional user-friendly display name for the customer.

When specified, this name is shown in user interfaces instead of the more technical customer name. It can include spaces, special characters, and be formatted for optimal readability.

Inherited from​

CustomerGeneric.displayName

embedLoginUrl?​

optional embedLoginUrl: string

URL for customer-specific embedding access.

When specified, this URL provides a custom authentication endpoint for secure embedded configurator access. This enables integration with the customer's own authentication systems.

history​

history: History

Revision and audit history for this customer account.

Contains a record of changes made to the customer profile, including timestamps and user identifiers for creation and modification events. This audit trail supports compliance requirements and helps troubleshoot configuration changes.

initLanguage?​

optional initLanguage: string

Initial language to use for this customer's configurator instances.

This defines the language that will be used when first loading configurator interfaces, before any user language preferences are applied.

planType?​

optional planType: string

Subscription tier or plan level for this customer.

Identifies which subscription level or service plan this customer has purchased, which may affect available features, limits, and support levels.

prefix​

prefix: string

Unique code prefix for this customer's resources.

This prefix is used in product codes, IDs, and other identifiers to ensure uniqueness across the system. It typically represents a short abbreviated form of the customer name or brand.

status​

status: Status

Current activation status of the customer account.

Indicates whether the customer is currently active (operational) or inactive (suspended). Only active customers can access configurator services and appear in normal operational flows.