Skip to main content
POST
Issue a license

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customer_id
string
required

Customer ID or alias

instance_id
string | null

Offline only. The installation's id as it reports it, up to 255 characters without spaces: the license names it (aud) and stays bound to it. Without one, the license is not tied to an installation.

offline
boolean

Delivers the license at once as a signed offline license, for an installation that can't reach the license server: no activation code, no refresh. Default: false.

subscription_id
string | null

Ties the license to this subscription of the customer: it is renewed while the subscription is paid, and carries its plan's entitlements.

validity_days
integer<int32> | null

Online: lifetime of each license token the installation refreshes, 1 to 31 days. Default: 7. Offline: lifetime of the signed license, 1 to 400 days. Default: 365.

Required range: x >= 0

Response

License issued

license
object
required
activation_code
string | null

Online: one-time code the customer enters in their installation to activate the license.

offline_license
string | null

Offline: the signed license (a JWT) to install in the installation.