Sign in

v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB
Licenses

Validates a license key or instance.

Verify if a license key is valid and active for a specific instance. Check activation status and expiration.

post/v1/licenses/validate

Request body

keystring required

The license key to validate.

instance_idstring required

Id of the instance to validate.

Response

Successfully validated a license key instance

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

A string representing the object's type. Objects of the same type share the same value.

product_idstring required

The ID of the product this license belongs to.

status'inactive' | 'active' | 'expired' | 'disabled' required

The current status of the license key.

keystring required

The license key.

activationnumber required

The number of instances that this license key was activated.

activation_limitnumber nullable

The activation limit. Null if activations are unlimited.

expires_atstring date-time nullable

The date the license key expires. Null if it does not have an expiration date.

created_atstring date-time required

The creation date of the license key.

Example response

{
  "product_id": "prod_abc123",
  "key": "ABC123-XYZ456-XYZ456-XYZ456",
  "activation": 5,
  "activation_limit": 1,
  "expires_at": "2023-09-13T00:00:00Z",
  "created_at": "2023-09-13T00:00:00Z",
  "instance": {
    "object": "license-instance",
    "name": "My Customer License Instance",
    "status": "active",
    "created_at": "2023-09-13T00:00:00Z"
  }
}