Product Versioning

The LicenseSpring service can be configured to return product version information on Activation, license checks, and other webhooks through the License API.

LicenseSpring does not host binaries to product versions. We simply provide a mechanism to handle product versions for a license

Add a Version to a Product

To add a new version of your product, open the product detail page, click the Versions tab, then click "Add new version".

Adding New Product Version

Product Version Fields

Required Fields

• Environment

• Version Number

• Release Date

Optional Fields

• Requires Version — Specify the minimum version required for someone to be able to update to the version being added. For example, if you are adding a new version 3.0.0 and you set "Requires version" to 2.0.0, then anyone with a version less than 2.0.0 will not be able to upgrade to 3.0.0.

• File hash — MD5 which you can use to help verify the integrity of the binaries being installed.

• File size — Defined in bytes, communicated so that you can display this information when offering a new version update.

• Link to file — Link to download the binaries of the new version.

• Link to release notes — Intended as a web page or text file to display release notes on the version.

• Link to EULA — Intended to show a web page or text file with the License Agreement for the app or unique to the app version.

• Channel — Could refer to a specific distribution or release channel for your software product versions. Different channels may serve different purposes (stability, testing, early access, etc.).

Product Versions Fields

Using Product Versions

The License API has a Get Product Versions webhook that allows you to retrieve all product versions for a given channel and environment. You can compare the release date of a product version with another timestamp, such as a license expiry date or maintenance window, to determine whether the version is allowed for this license.

Similarly, you can check the latest product version against the version currently installed to conditionally prompt the user to download an update to their software using the Get Installation File endpoint.

Link License to max product version

LicenseSpring supports linking licenses to specific product versions, allowing fine-grained control over license applicability. This enables scenarios where a license should only be valid up to a designated version of a product.

Product version on a license

If a license is linked to a version, any license check or activation request must respect this version limit.

When a license is linked to a product version:

• The client may send the app_ver parameter to specify the version of the product they’re using.

• If the app_ver is newer than the version linked to the license, the API will return product_version_not_supported error.

This can be verified only if the app_ver parameter is sent with license activation (online and offline) and check requests. If a license is not linked to any product version, then no version validation is enforced. Version validation is possible only if versions follow semantic versioning format.

Product version can also be applied to a license policy. If a license is created via a license policy that has a product version assigned to it, the license inherits that product version.

License bundles are not supported with product version linking.