Skip to main content
POST
Activates a license key.

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Body

application/json

License activation request payload

key
string
required

The license key to activate.

instance_name
string
required

A label for the new instance to identify it in Creem.

Response

Successfully activated a license key

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.

product_id
string
required

The ID of the product this license belongs to.

Example:

"prod_abc123"

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<date-time>
required

The creation date of the license key.

Example:

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

activation_limit
number | null

The activation limit. Null if activations are unlimited.

Example:

1

expires_at
string<date-time> | null

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

Example:

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

instance
object | null

Associated license instances.