Renews an existing license session by extending its lease expiration time. Returns updated license information reflecting the new expiration. The benefit of this method over creating a new license session is that no license reactivation is needed, which may require user interaction.
const url = 'https://example.com/api/v1/provision/activations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/renew';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/provision/activations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/renewExtends lease / grace according to entitlement or session policy.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The unique identifier of the license session to renew.
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”Session renewed successfully.
End user license token with meta data.
object
The signed license JWT the SDK validates offline against the provider’s public key.
Link to the license terms (EULA) the license was issued under: an absolute https URL, or null when the entitlement has none. Unsigned display metadata, read from the entitlement at every issue and refresh.
A feature as activated on an end-user license: the granted value, enablement, trial/grace availability, and optional per-feature expiration.
object
The metric a metered feature’s usage is recorded under, resolved by the issuer. A feature code
and its metric name are deliberately different strings (MIRAGE.IMAGE.RENDERS against
mirage.image.renders) and the server matches a meter by exact metric name, so this is the
only name usage may be reported under. Null for a feature that has no meter, or when the issuer
did not resolve one.
What the feature’s value is counted in (GB, seats, calls), read from the vendor’s catalog at every issue, for showing beside the value. Null for a Boolean feature, or when the catalog names none. Unsigned display metadata, like string? ActivatedFeatureDto.Name.
When true, the feature is withheld for the duration of a trial even if enabled.
The issuer’s verdict that this license explicitly does not grant the feature. Validation treats it as final, while the feature stays present for display — a locked capability can still be shown, and reaching for it is counted as a denied check.
A product covered by the license, with the custom properties the vendor marked Public. Display/catalog metadata carried on the unsigned EndUserLicenseDto envelope, like feature names and descriptions, so it must never gate functionality. The product code and version are also in the signed token (SignedProductDto); gate on that copy.
object
The version of the product the license was issued for, for display; empty when the product has none.
object
A custom key/value property (e.g. on a product) with optional metadata entries.
object
A key/value metadata entry attached to a PropertyValueDto.
object
Whether a custom property is sent to the application with its license.
The license’s meters, one per metric name, with the unit each counts in.
A meter of the license: the metric name its usage is recorded and limited under (the key in the
signed usage_limits claim) and the unit it counts in. Display metadata carried on the unsigned
EndUserLicenseDto envelope, read from the same record as the customer API’s meter
(string MyMonitoredAssetDto.Unit), so both report the same unit. A meter of a feature the
license withholds is left out, as the feature is.
object
What the meter counts, e.g. renders or minutes; null when the meter names none.
Example
{ "products": [ { "propertyValues": { "additionalProperty": { "visibility": "Private" } } } ]}The session is outside its validity window, its lease has lapsed, or its identity is not verified (operation.invalid).
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}User not authorized to renew this session.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Session renewal forbidden (e.g., entitlement revoked).
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}The session no longer exists: deleted or revoked (license.no_active_session).
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Too many requests – rate limit exceeded.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Internal Server Error