License Keys
The License Key Management feature is designed to help merchants secure their digital products and services by generating, managing, and tracking unique license keys. This feature ensures only authorized users access your products and provides merchants with full control over their license key usage and distribution. Ideal for SaaS businesses and digital product vendors, the tool also includes advanced tracking and revocation capabilities for enhanced security.
How to Create License Keys?
Creating license keys is a simple process:
- Access the License Key Section:
- Log in to your Dodo Payments dashboard.
- Navigate to the Products tab and select a Product
- Click on
License Key
:- Click on License Key section in the selected product
- Configure the License Key Settings:
Provide the following details:
- License Key Expiry Date: Define the validity period of the license key. It will be never expire by default which means the license key will always be valid
- Activation Limit: Set the total number of activations allowed per key. It will unlimited by default which means unlimited activations will be allowed
- Activation Instructions: Add clear instructions to guide customers through the activation process. This will be sent along with the license key email.
- Preview and Save:
- Review the license key settings to ensure accuracy.
- Click Save to create the license key.
- Automatic Delivery:
- The license key is delivered to the customer via email upon successful transaction along with the activation instructions
Understanding License Key Configuration
Here’s a detailed explanation of each configuration field:
License Key Expiry Date
- What It Does: Defines the duration for which the license key remains active.
- Example: A key can be set to expire after 30 days, 1 year, or no expiry (perpetual).
- Purpose: Ideal for subscription services or time-limited products.
Activation Limit
- What It Does: Sets the maximum number of times a key can be activated.
- Example: A single-user license may allow 1 activation, while a team license may allow 5 activations.
- Purpose: Prevents overuse or unauthorized sharing.
Activation Instructions
- What It Does: Guides customers on how to activate their license key.
- Example:
- “Enter your license key in the software activation field.”
- “Use the key to unlock premium features in your account settings.”
- Purpose: Simplifies the activation process and reduces customer queries.
License Keys Section
The License Keys Section provides a comprehensive view of all license key activity and enables merchants to manage and monitor their licenses effectively. This section includes the following features:
Information Available:
- Key Details:
- License key value.
- Associated product name.
- Customer details (e.g., customer_id)
- Purchase date.
- Usage Activity:
- Number of activations.
- Activation dates and times.
- Status (active, expired, disabled)
- Expiry and Limits:
- Key expiry date.
- Remaining activation count
- Current activation instances
Actions Available:
- Disable License Key:
- Immediately disable a key to prevent further usage.
- Enable Key:
- Enable a previously disabled license key.
- View Activation Instances:
- View all associated activation instances for a particular license key
Benefits of License Key information :
- Enables merchants to track license key activity in real-time.
- Identifies potential misuse or unauthorized activations.
- Simplifies customer support by providing detailed usage records in case of discrepancy.
Technical Integration
This section provides details on how to integrate and utilize the License Key Management feature using the available APIs.
1. License Key Action APIs
POST: Activate License
Activates a license key instance to grant customer access to the associated product.
POST: Deactivate License
Deactivates a previously activated license key instance, freeing it for reuse or managing activation limits.
POST: Validate License
Validates a license key to confirm its authenticity, validity, and compliance with set parameters.
2. License Key Management and Query APIs
GET: Get License Keys
Retrieves a list of all license keys for a merchant, including their status and usage details.
GET: Get License Key
Fetches details of a specific license key, including expiry, usage limits, and activation history.
PATCH: Update License Key
Modifies details of an existing license key, such as expiry date, activation limits, enabling or disabling a license key.
3. License Key Instance APIs
GET: Get License Key Instances
Retrieves all instances of activations for a specific license key.
GET: Get License Key Instance
Fetches details of a specific license key activation instance, such as device information and activation timestamp.
PATCH: Update License Key Instance
Updates details of a specific license key activation instance, such as revoking access or modifying device information.
By utilizing these APIs, merchants can seamlessly manage license key creation, validation, and monitoring. These endpoints enable complete automation for tracking and securing digital products, ensuring a robust and scalable solution.