POST
/
v1
/
licenses
/
validate
Validates a license key or instance.
curl --request POST \
  --url https://api.creem.io/v1/licenses/validate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "key": "<string>",
  "instance_id": "<string>"
}'
{
  "id": "<string>",
  "mode": "test",
  "object": "<string>",
  "status": "active",
  "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": {
    "id": "<string>",
    "mode": "test",
    "object": "license-instance",
    "name": "My Customer License Instance",
    "status": "active",
    "created_at": "2023-09-13T00:00:00Z"
  }
}

Headers

​
x-api-key
string
required

Body

application/json
​
key
string
required

The license key to validate.

​
instance_id
string
required

Id of the instance to validate.

Response

200 - application/json

Successfully validated a license key instance

​
id
string
required

Unique identifier for the object.

​
mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
​
object
string
required

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

​
status
enum<string>
required

The current status of the license key.

Available options:
inactive,
active,
expired,
disabled
Example:

"active"

​
key
string
required

The license key.

Example:

"ABC123-XYZ456-XYZ456-XYZ456"

​
activation
number
required

The number of instances that this license key was activated.

Example:

5

​
created_at
string
required

The creation date of the license key.

Example:

"2023-09-13T00:00:00Z"

​
activation_limit
object | null

The activation limit. Null if activations are unlimited.

Example:

1

​
expires_at
object | null

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

Example:

"2023-09-13T00:00:00Z"

​
instance
object

Associated license instances.