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.

POST

/api/v1/provision/activations/{sessionId}/renew

curl --request POST \
  --url https://example.com/api/v1/provision/activations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/renew

Extends lease / grace according to entitlement or session policy.

Parameters

Path Parameters

sessionId

required

string format: uuid

The unique identifier of the license session to renew.

Header Parameters

X-Correlation-Id

string

Responses

200

Session renewed successfully.

Media typeapplication/json

End user license token with meta data.

object

licenseToken

The signed license JWT the SDK validates offline against the provider’s public key.

string

version

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

legalNotice

string

copyright

string

providerUrl

string

providerEmail

string

description

string

licensedProducts

Array<string>

activatedFeatures

Array<object>

A feature as activated on an end-user license: the granted value, enablement, trial/grace availability, and optional per-feature expiration.

object

id

string format: uuid

featureCode

string

productId

string format: uuid

moduleName

null | string

featurePath

null | string

name

null | string

description

null | string

value

null | string

version

null | string

isEnabled

boolean

isAvailableDuringTrialPeriod

boolean

isAvailableDuringGracePeriod

boolean

isPaidFeature

When true, the feature is withheld for the duration of a trial even if enabled.

boolean

isDenied

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.

boolean

featureExpiration

null | string format: date-time

Example^generated

{
  "licenseToken": "example",
  "version": 1,
  "legalNotice": "example",
  "copyright": "example",
  "providerUrl": "example",
  "providerEmail": "example",
  "description": "example",
  "licensedProducts": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "activatedFeatures": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCode": "example",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "moduleName": "example",
      "featurePath": "example",
      "name": "example",
      "description": "example",
      "value": "example",
      "version": "example",
      "isEnabled": true,
      "isAvailableDuringTrialPeriod": true,
      "isAvailableDuringGracePeriod": true,
      "isPaidFeature": true,
      "isDenied": true,
      "featureExpiration": "2026-04-15T12:00:00Z"
    }
  ]
}

401

User not authorized to renew this session.

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Session renewal forbidden (e.g., entitlement revoked).

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Session not found or expired.

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too many requests – rate limit exceeded.

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

500

Internal Server Error

Media typeapplication/json