Skip to main content

01 Fundamental configurations

Welcome to keylight. In the following chapters of this quick start guide, you will find the necessary configurations to set up your subscription business on keylight. Admins can use this guide as a reference for advanced configurations and understand how keylight can effortlessly help meet their requirements and goals.

For a quick start, this guide will provide an overview of the essential settings to launch a shop. To explore advanced settings, click on "Learn more..." below each task. It is recommended to complete the chapters and their respective tasks in the suggested order, as many of the configurations are connected with previous settings.

Before you begin​

  • Log in to your keylight sandbox. In this quick start guide, you will be only working in the Configuration App, so make sure the App Launcher is set to Configuration.

  • Navigate to Fundamentals in the top menu bar, where you can find the initial settings before any other configuration in keylight. The tasks in this chapter are as follows:

Add a currency​

Currencies allow you to define the currency in which you conduct business and bill your customers. You can set up multiple currencies as needed.

To add a currency:

  1. Navigate to Fundamentals > Currencies.
  2. Click Create New.
  3. From the drop-down list, select the ISO Code for the currency in which you are conducting business. Find the corresponding ISO code for your currency.
  4. Enter a number in the Rounding Increment and select a Rounding Mode.
  5. Click Create.

Learn more about currencies, rounding increments, and rounding modes.

Add a language​

Languages determine the display of labels and texts in your Public Apps. You can configure multiple languages for the regions in which you are selling your products.

To add a language for your public applications:

  1. Navigate to Fundamentals > Languages.
  2. Click Create New.
  3. From the drop-down list, Select the ISO Code for the language you want to configure. Find the corresponding ISO code for the languages.
  4. Click Create.

Learn more about languages and localization.

Configure periods​

In keylight, Periods refer to specific time intervals, such as days, weeks, months, or years. These periods are used throughout the platform for various purposes, including billing and price periods, subscription plans and payment terms.

To configure a period:

  1. Navigate to Fundamentals > Periods.
  2. Click Create New.
  3. Enter a name for the type of your period in Name. For example, Month, Quarter, or Year.
  4. From the Period drop-down list, you can configure the time interval by selecting a unit of time and entering the desired number of time units on the left side of the textbox.
  5. Optional: Enter Labels to provide context in which the period will be used. These labels will be shown in user-facing components within Public Apps. If no labels are entered, the default label for each context will be displayed.
  6. Click Create.

Learn more about Periods.

Define product metrics​

*You only need to define Metrics when you are selling a quantity-based product.

Metrics are units of measurement that your business uses to quantify your products, both tangible goods and intangible services. A Metric does not have to be billable; a product can use multiple metrics to track, measure, and bill customer activities. keylight differentiates metrics into two types, Fixed and Usage.

Fixed Metric​

A fixed metric does not vary in value with usage. The value and price are established at the start of a subscription term, and payment for the product is made in advance before utilization begins. Examples of fixed metrics are "500 minutes of calls per month" and "5 licenses".

Usage Metric​

A usage-based metric varies with usage and counts upward over a period of time. Billing takes place after utilization, and customers are charged based on the usage over the agreed period. Examples of usage-based metrics are "total minutes of calls" or "every license activated".

Note: A Product can have both a fixed and usage-based metric, in which the customer pays a predetermined fee with a specified limit and is charged for any usage exceeding that limit.

To define a new metric for your product:

  1. Navigate to Fundamentals > Metrics.
  2. Click Create New.
  3. Type in the unit of measurement for your product in the Name textbox. For example, devices, users, minutes, or gigabytes.
  4. From the Type drop-down list, select "Fixed" or "Usage".
  5. Type "0" in Decimal Places, if the number of units cannot be a fraction of a whole number. For example, you can't have half a device or half a user, so the decimal places would be "0". For other metrics such as minutes or gigabytes, you can define the desired decimal number.
  6. Optional: Enter a translatable Price Label that will appear next to the metric's price in your webshop.
  7. Click Create.

Learn more about metrics.