License Keys

In Lemon Squeezy, a license key can be used to externally verify that customer has access to a product.

A license key belongs to a Store and is associated with an Order, an Order Item and a Product.

Note, if you’re looking to integrate license keys into your application (e.g. activate/validate/deactivate license keys), see our separate licenses API documentation.

The license key object

Attributes

store_id

The ID of the store this license key belongs to.

order_id

The ID of the order associated with this license key.

order_item_id

The ID of the order item associated with this license key.

product_id

The ID of the product associated with this license key.

user_name

The full name of the customer.

user_email

The email address of the customer.

key_short

A “short” representation of the license key, made up of the string “XXXX-” followed by the last 12 characters of the license key.

activation_limit

The activation limit of this license key.

instances_count

A count of the number of instances this license key has been activated on.

disabled

Has the value true if this license key has been disabled.

status

The status of the license key. One of inactiveactiveexpireddisabled.

status_formatted

The formatted status of the license key.

expires_at

An ISO-8601 formatted date-time string indicating when the license key expires. Can be null if the license key is perpetual.

created_at

An ISO-8601 formatted date-time string indicating when the object was created.

updated_at

An ISO-8601 formatted date-time string indicating when the object was last updated.

License key object

{
  "type": "license-keys",
  "id": "1",
  "attributes": {
    "store_id": 1,
    "order_id": 1,
    "order_item_id": 1,
    "product_id": 1,
    "user_name": "Darlene Daugherty",
    "user_email": "gernser@yahoo.com",
    "key_short": "XXXX-81144c51d1da",
    "activation_limit": 5,
    "instances_count": 0,
    "disabled": 0,
    "status": "inactive",
    "status_formatted": "Inactive",
    "expires_at": null,
    "created_at": "2021-05-24T14:15:07.000000Z",
    "updated_at": "2021-05-24T14:15:07.000000Z"
  },
}

Retrieve a license key

Retrieves the license key with the given ID.

Returns

Returns a license key object.

GET /v1/license-keys/:id

curl "https://api.lemonsqueezy.com/v1/license-keys/1" \
     -H 'Accept: application/vnd.api+json' \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer {api_key}'

Response

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1"
  },
  "data": {
    "type": "license-keys",
    "id": "1",
    "attributes": {
      "store_id": 1,
      "order_id": 1,
      "order_item_id": 1,
      "product_id": 1,
      "user_name": "Darlene Daugherty",
      "user_email": "gernser@yahoo.com",
      "key_short": "XXXX-81144c51d1da",
      "activation_limit": 5,
      "instances_count": 0,
      "disabled": 0,
      "status": "inactive",
      "status_formatted": "Inactive",
      "expires_at": null,
      "created_at": "2021-05-24T14:15:07.000000Z",
      "updated_at": "2021-05-24T14:15:07.000000Z"
    },
    "relationships": {
      "store": {
        "links": {
          "related": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/store",
          "self": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/relationships\/store"
        }
      },
      "order": {
        "links": {
          "related": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/order",
          "self": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/relationships\/order"
        }
      },
      "order-item": {
        "links": {
          "related": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/order-item",
          "self": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/relationships\/order-item"
        }
      },
      "product": {
        "links": {
          "related": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/product",
          "self": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1\/relationships\/product"
        }
      }
    },
    "links": {
      "self": "https:\/\/api.lemonsqueezy.com\/v1\/license-keys\/1"
    }
  }
}

List all license keys

Returns a paginated list of license keys.

Parameters

store_id

Only return license keys belonging to the store with this ID.

order_id

Only return license keys belonging to the order with this ID.

order_item_id

Only return license keys belonging to the order item with this ID.

product_id

Only return license keys belonging to the product with this ID.

Returns

Returns a paginated list of license key objects ordered by id.

GET /v1/license-keys

curl "https://api.lemonsqueezy.com/v1/license-keys" \
     -H 'Accept: application/vnd.api+json' \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer {api_key}'

Response

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 10,
      "to": 10,
      "total": 10
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id",
    "last": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id",
  },
  "data": [
    {
      "type": "license-keys",
      "id": "1",
      "attributes": {
        "store_id": 1,
        "order_id": 1,
        "order_item_id": 1,
        "product_id": 1,
        "user_name": "Darlene Daugherty",
        "user_email": "gernser@yahoo.com",
        "key_short": "XXXX-81144c51d1da",
        "activation_limit": 5,
        "instances_count": 0,
        "disabled": 0,
        "status": "inactive",
        "status_formatted": "Inactive",
        "expires_at": null,
        "created_at": "2021-05-24T14:15:07.000000Z",
        "updated_at": "2021-05-24T14:15:07.000000Z"
      },
      "relationships": {
        "store": {
          "links": {
            "related": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/store",
            "self": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/relationships\/store"
          }
        },
        "order": {
          "links": {
            "related": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/order",
            "self": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/relationships\/order"
          }
        },
        "order-item": {
          "links": {
            "related": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/order-item",
            "self": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/relationships\/order-item"
          }
        },
        "product": {
          "links": {
            "related": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/product",
            "self": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1\/relationships\/product"
          }
        }
      },
      "links": {
        "self": "https:\/\/api.lemonsqueezy.test\/v1\/license-keys\/1"
      }
    },
    {...},
    {...},
  ]
}