Custom License Fields

Metadata properties

The metadata, which can be added to products, licenses, and users, has the following three properties:

Key

Name of the metadata key.

Value

Value of the metadata key.

View Permissions

Admins can control the visibility of metadata by configuring the metadata permissions as follows:

• Activation: Metadata will be accessible to developers in the LexActivator SDK (and via Web API through the POST v3/activations endpoint).

• User: Metadata will be visible to users within the customer portal (and via Web API through the GET v3/me/licenses endpoint).

• Organization: Metadata will be visible to the organization-admins in the customer portal (and via Web API through the GET v3/organizations/:id/licenses endpoint).

• Reseller: Metadata will be visible to reseller-admins in the reseller portal (and via Web API through the GET v3/resellers/:id/licenses endpoint).

Product metadata

This metadata can be added to products and can be accessed in your application once a trial or license is activated.

It can be used for storing some product-level information that you want to access in your app, and this information can change over time.

License metadata

License metadata allows you to attach custom data to each license at the time of creation. You can store useful identifiers such as order_id, customer_id, or any other key-value data relevant to your business logic.

This metadata can also be accessed within your application once the license is activated, making it ideal for use cases where additional context is needed alongside the license.

In order to require licenses to have specific metadata properties, set them in the license template's requiredMetadataKeys field.

Enforcing a schema for metadata fields

You can enforce the schema for metadata fields in the license template, too, so you don't have to manually create the fields every time you create a license. Just provide the field names as comma-separated strings, e.g. order_id, customer_id etc. in the required metadata keys property of the license template.

User metadata

This metadata can be added to your license users at the time of creating a user. You can store additional data like phone_number, address etc. in the user metadata.

Activation metadata

This metadata can be added by your application at the time of activating the license.

It can be used to collect additional details from the machine on which the license is activated, e.g., number of CPU cores, any custom data provided by the user, etc.

Trial activation metadata

This metadata can be added by your application at the time of activating the trial.

It can be used to collect additional details from the machine on which the trial is activated, e.g., number of CPU cores, any custom data provided by the user, etc.