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, a Product and can have many License Key Instances.
Note, if you're looking to integrate license keys into your application (e.g. activate/validate/deactivate license keys), see our separate license API documentation.
The license key object
Attributes
store_id
The ID of the store this license key belongs to.
customer_id
The ID of the customer 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
The full license key.
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
inactive
active
expired
disabled
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
Retrieve a license key
Retrieves the license key with the given ID.
GET /v1/license-keys/:id
Returns
Returns a license key object.
Response
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.
GET /v1/license-keys
Returns
Returns a paginated list of license key objects ordered by id
.