Skip to main content
POST
/
v1
/
license-keys
/
validate
Validate License Key
curl --request POST \
  --url https://api.spairehq.com/v1/license-keys/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "organization_id": "<string>",
  "activation_id": "<string>",
  "benefit_id": "<string>",
  "customer_id": "<string>",
  "increment_usage": 123,
  "conditions": {}
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "customer_id": "<string>",
  "customer": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "<string>",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "<string>",
    "type": "individual"
  },
  "benefit_id": "<string>",
  "key": "<string>",
  "display_key": "<string>",
  "limit_activations": 123,
  "usage": 123,
  "limit_usage": 123,
  "validations": 123,
  "last_validated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "activation": {
    "id": "<string>",
    "license_key_id": "<string>",
    "label": "<string>",
    "meta": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You can generate a Personal Access Token from your settings.

Body

application/json
​
key
string
required
​
organization_id
string<uuid4>
required
​
activation_id
string<uuid4> | null
​
benefit_id
string<uuid4> | null

The benefit ID.

​
customer_id
string<uuid4> | null
​
increment_usage
integer | null
​
conditions
Conditions · object

Key-value object allowing you to set conditions that must match when validating the license key.

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

Response

Successful Response

​
id
string<uuid4>
required

The ID of the object.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
organization_id
string<uuid4>
required
​
customer_id
string<uuid4>
required
​
customer
LicenseKeyCustomer · object
required
​
benefit_id
string<uuid4>
required

The benefit ID.

​
key
string
required
​
display_key
string
required
​
status
enum<string>
required
Available options:
granted,
revoked,
disabled
​
limit_activations
integer | null
required
​
usage
integer
required
​
limit_usage
integer | null
required
​
validations
integer
required
​
last_validated_at
string<date-time> | null
required
​
expires_at
string<date-time> | null
required
​
activation
LicenseKeyActivationBase · object