License Types

one of the fundamental building blocks of a license within our model is the license type every license issued will always have a type in the vendor platform, this appears in many places, such as the license summary page as well as on the license detail page license type appearing on the license detail screen you cannot change the license type once it has been created licensespring defines 4 types of licenses perpetual time limited subscription consumption let's dive into the different license types perpetual license a perpetual license does not expire the is expired field on a license check will always return false at the time of this writing, we distinguish a trial license through a boolean value istrial if a license is of type trial, then the date stored in the validity period refers to the validity period of the trial for example, if the license is of type perpetual , and istrial is true, you would see a perpetual license with an expiry date in the vendor platform statuses of a perpetual license inactive the times activated for this given license is 0 , meaning that this license has not been bound to a device active the times activated for this field is greater than 0 , meaning that the license has been bound to at least one device disabled the license has been disabled by the vendor, this will override other rules for this status time limited license time limited licenses always have a calendar date as a value in the expiry date row that you can see in the vendor platform on a license check, the field is expired will be true if the expiry date is earlier than the server's current date, and false if the expiry date of the license is at a future date than the server's timestamp status of a time limited license inactive the total activations for this given license is 0 , meaning that this license has not been bound to a device active the total activations for this field is greater than 0 , meaning that the license has been bound to at least one device disabled the license has been disabled by the vendor, this will override other rules for this status there are other timestamps you can work with, instead of just at the license type level for instance, you can set an expiry date for a specific feature, or define a maintenance period validity setting a pre determined expiration date users can set a pre determined expiration date for a license that does not depend on the time of first activation by doing the following at time of issuance subscription license a subscription license synchronizes the status of the subscription with the state of the license for a subscription license, licensespring requires an integration to an external source of truth (like a recurring billing system) licensespring updates the status of the license according to the status of the subscription, which is handled by a 3rd party unlike the other license types you can encounter in licensespring, the status is not dependent on the value of the times activated field instead, a license of type subscription will be active once created, and will remain active until the system handling the subscription tells licensespring that the subscription is no longer active (cancelled, refunded, etc) in this case, the license status will be set to inactive subscription grace period grace periods offer you the flexibility to determine a specific timeframe, measured in hours, subsequent to the expiry of the designated validity period during this defined interval, the license will retain its validity ( isexpired() status will remain false), ensuring a seamless transition even after the official expiration status of a subscription license inactive licensespring received information from the external source of truth stating that the subscription is no longer active active this is the default state of a subscription license, when it is created disabled the license has been disabled by the vendor, this will override other rules for this status consumption license a consumption license, also known as a metered license, permits usage metering consumption licenses work by setting a value the the resource the vendor wishes to meter, and then recording the times that resource has been used the resource can really be anything that has a discrete value, for example times the software was run the number of api requests made number in minutes that a pooled resource was used credit consumption licenses support overages, total consumptions can be incremented or decremented (by adding a negative value), and the total consumptions can be periodically reset unique fields in a consumption license unique fields for a consumption license max consumptions number of "consumptions" granted to the end user total consumptions number of "consumptions" the end user has currently consumed this number must be less than or equal to the max consumptions + max overages overages if overages are allowed, then the software vendor can specify a value that the license can exceed the value for max consumptions by otherwise, the max overages is 0 consumption period if this field is set, then the value for total consumptions is reset to 0 the consumption period can be daily , weekly , monthly or annually daily is reset at midnight utc weekly is reset on monday at midnight utc monthly is reset on the first day of the month at midnight utc annually is reset on the first day of the year at midnight utc status of a consumption license inactive the total activations for this given license is 0 , meaning that this license has not been bound to a device active the total activations for this field is greater than 0 , meaning that the license has been bound to at least one device disabled the license has been disabled by the vendor, this will override other rules for this status licensespring also allows an isv to meter the usage of an individual module or component by defining features consumptions, and adding them as part of the license entitlements