website logo
⌘K
Getting Started
Introduction
Basic Concepts
Opening an Account
Creating & Configuring Products
Integrating SDK and Configuring License Fulfillment
Activate a Key-Based License
Vendor Platform
Issuing New Licenses
License Detail View
Order Detail View
Customer Detail View
Metadata
Analytics
Settings
Product Configuration
Product Features
Product Custom Fields
Product Versioning
License Policies
Product Bundles
License Entitlements
License Types
Activations & Device Transfers
Features
Custom Fields
License Start Date
License Note
Maintenance Period
Trial Licenses
Floating Licenses
License Activation Types
Portals
End-User Portal
Offline Portal
Air-Gapped Portal
License API
License API Authorization
License Activation/Deactivation
License Check
Consumption
Floating
Trial Key
Product Details
Device Variables
Changing Password
Management API
Making API Requests
Management API Authorization
Customer
Product
Order
License
Device
Analytics
SDKs
Tutorials
.NET/C# SDK
.NET/C# Management SDK
C++ SDK
Java SDK
Python SDK
Go SDK
Delphi SDK
Swift/Objective-C SDK
Android SDK
Unity SDK
Errors and Response Codes
Floating Server
API Reference
Deployment
Configuration
Floating Server UI
Securing the Server
Whitelabeling
FAQ
Floating Server Changelog
Integrations
Salesforce
FastSpring
Stripe
Shopify
Common Scenarios
Single Sign On (SSO)
Glossary
General
SDK Glossary
Vendor Platform
Product Configuration Glossary
License Configuration
Postman Collections
Frequently Asked Questions
Changelog
License API changelog
Platform changelog
Docs powered by
Archbee
Vendor Platform

Metadata

10min

Metadata is a powerful feature introduced in LicenseSpring that allows you to attach custom information to various levels within your licensing infrastructure.

It serves as a flexible and extensible mechanism for storing additional data related to licenses, features, products, and customers.

The metadata JSON is stored as a string, providing a wide range of possibilities for customization.

Levels of Metadata

Metadata can be applied at four different levels within LicenseSpring, providing flexibility and granularity in managing your licensing data.

License Metadata

License metadata allows you to attach custom information to individual licenses. This level of metadata is particularly useful for storing license-specific details that are unique to each instance.

For example, you can add metadata to indicate the activation date, license type, or any other relevant information specific to a particular license.

Metadata Location in License Detail View
Metadata Location in License Detail View


Feature Metadata

Feature metadata allows you to associate custom information with specific features within your licensing structure.

This level of metadata can be used to store additional details about individual features, such as version numbers, release dates, or any other feature-specific data that you wish to track.

Metadata Location in License Feature Detail View
Metadata Location in License Feature Detail View


Product Metadata

Product metadata enables you to store custom information related to your products. This level of metadata is useful for storing product-specific details that are applicable to all licenses associate.

Product metadata is returned from license check inside the product details object.

Metadata Location in Product Detail View
Metadata Location in Product Detail View


Customer Metadata

Customer metadata allows you to attach custom information to individual customers. This level of metadata is particularly helpful for storing customer-specific details that may be important for managing your licensing relationships.

For instance, you can add metadata to store customer preferences, contact information, or any other relevant data that pertains to a specific customer.

Metadata Location in Customer Detail View
Metadata Location in Customer Detail View


Working with Metadata

Managing metadata in LicenseSpring involves the adding and retrieving of metadata at the desired levels. Here's a brief overview of the basic operations for working with metadata.

Adding Metadata:

To add metadata to a license, feature, product, or customer, you can use the appropriate API method provided by LicenseSpring.

The metadata field is initially established on the product feature and, along with other fields, acts as a default value. When a license is created with specific product features, we utilize those features to generate license_product_feature items, inheriting default values from the product_features, and assign them to the license.

Then, the metadata on the license product features can remain unchanged or be modified on a per-license basis, depending on your preferences. If no modifications are made, the metadata will persist in its original state.

Retrieving Metadata

To retrieve metadata associated with a license, feature, product, or customer, you can utilize the method metadata() on the License, LicenseFeature, ProductDetails, and Customer classes. By providing the relevant identifier, the API will return the metadata string associated with the specified entity.

Note: It's important to remember that metadata will only affect the specific entity to which it is attached and will not impact other licenses, features, products, or customers.



Updated 05 Sep 2023
Did this page help you?
PREVIOUS
Customer Detail View
NEXT
Analytics
Docs powered by
Archbee
TABLE OF CONTENTS
Levels of Metadata
License Metadata
Feature Metadata
Product Metadata
Customer Metadata
Working with Metadata
Adding Metadata:
Retrieving Metadata
Docs powered by
Archbee