Skip to main content
POST
/
v1
/
licenses
Create
curl --request POST \
  --url https://{defaultHost}/v1/licenses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "license": {
    "key": "abc-123-def-456",
    "purchase": "f2bd5cff-b08e-4f2a-92c6-d6fd8b8fe547"
  }
}
'
{
  "id": "94a20eb0-ea26-4737-9d57-391e15260832",
  "object": "license",
  "activations_count": 0,
  "activation_limit": null,
  "key": "abc-123-def-456",
  "revokes_at": null,
  "status": "inactive",
  "customer": "0bd6ac0b-621b-4bd2-9ded-33a395dd01ae",
  "purchase": "f2bd5cff-b08e-4f2a-92c6-d6fd8b8fe547",
  "created_at": 1767909713,
  "updated_at": 1767909713
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
license
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
activation_limit
integer | null

The max number of activations allowed. If set to null then unlimited activations are allowed.

​
key
string

The unique identifier for this license. The default generated value is a UUID, but this can be set to any unique value within the scope of this account.

​
activations_count
integer

The current number of activations.

​
revokes_at
integer | null

Time at which the license will be revoked. Measured in seconds since the Unix epoch.

​
status
string

The status of this license which is one of active, inactive, or revoked. If the associated purchase is revoked then the license will be revoked. If the license has one or more activations then it will be active, otherwise it will be inactive.

​
customer

Expandable – The associated customer ID.

​
purchase

Expandable – The associated purchase ID.

​
activations

Expandable – Property not returned unless expanded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.