The ID of the store this product belongs to.
The name of the product.
The slug used to identify the product.
The description of the product in HTML.
The status of the product. Either draft
or published
.
The formatted status of the product.
A URL to the thumbnail image for this product (if one exists). The image will be 100x100px in size.
A URL to the large thumbnail image for this product (if one exists). The image will be 1000x1000px in size.
A positive integer in cents representing the price of the product.
Has the value true
if this is a “pay what you want” product where the price can be set by the customer at checkout.
If this product has multiple variants, this will be a positive integer in cents representing the price of the cheapest variant. Otherwise, it will be null
.
If this product has multiple variants, this will be a positive integer in cents representing the price of the most expensive variant. Otherwise, it will be null
.
A URL to purchase this product using the Lemon Squeezy checkout.
A human-readable string representing the price of the product (e.g. $9.99
).
An ISO-8601 formatted date-time string indicating when the object was created.
An ISO-8601 formatted date-time string indicating when the object was last updated.
{
"type": "products",
"id": "1",
"attributes": {
"store_id": 1,
"name": "Example Product",
"slug": "example-product",
"description": "<p>Lorem ipsum...<\/p>",
"status": "published",
"status_formatted": "Published",
"thumb_url": "https:\/\/app.lemonsqueezy.com\/storage\/media\/1\/1c40f227-aed5-4321-9ffc-62f37a06c9a0.jpg",
"large_thumb_url": "https:\/\/app.lemonsqueezy.com\/storage\/media\/1\/1c40f227-aed5-4321-9ffc-62f37a06c9a0.jpg",
"price": 999,
"pay_what_you_want": false,
"from_price": null,
"to_price": null,
"buy_now_url": "https:\/\/my-store.lemonsqueezy.com\/checkout\/buy\/0a841cf5-4cc2-4bbb-ae5d-9529d97deec6",
"price_formatted": "$9.99",
"created_at": "2021-05-27T12:54:47.000000Z",
"updated_at": "2021-07-14T11:25:24.000000Z"
}
}
Retrieves the product with the given ID.
Returns a product object.
curl "https://api.lemonsqueezy.com/v1/products/1" \
-H 'Accept: application/vnd.api+json' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer {api_key}'
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1"
},
"data": {
"type": "products",
"id": "1",
"attributes": {
"store_id": 1,
"name": "Example Product",
"slug": "example-product",
"description": "<p>Lorem ipsum...<\/p>",
"status": "published",
"status_formatted": "Published",
"thumb_url": "https:\/\/app.lemonsqueezy.com\/storage\/media\/1\/1c40f227-aed5-4321-9ffc-62f37a06c9a0.jpg",
"large_thumb_url": "https:\/\/app.lemonsqueezy.com\/storage\/media\/1\/1c40f227-aed5-4321-9ffc-62f37a06c9a0.jpg",
"price": 999,
"pay_what_you_want": false,
"from_price": null,
"to_price": null,
"buy_now_url": "https:\/\/my-store.lemonsqueezy.com\/checkout\/buy\/0a841cf5-4cc2-4bbb-ae5d-9529d97deec6",
"price_formatted": "$9.99",
"created_at": "2021-05-27T12:54:47.000000Z",
"updated_at": "2021-07-14T11:25:24.000000Z"
}
"relationships": {
"store": {
"links": {
"related": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/store",
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/relationships\/store"
}
},
"variants": {
"links": {
"related": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/variants",
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/relationships\/variants"
}
}
},
"links": {
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1"
}
}
}
Returns a paginated list of products.
Only return products belonging to the store with this ID.
Returns a paginated list of product objects ordered by name
.
curl "https://api.lemonsqueezy.com/v1/products" \
-H 'Accept: application/vnd.api+json' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer {api_key}'
{
"meta": {
"page": {
"currentPage": 1,
"from": 1,
"lastPage": 1,
"perPage": 10,
"to": 10,
"total": 10
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https:\/\/api.lemonsqueezy.com\/v1\/products?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=name",
"last": "https:\/\/api.lemonsqueezy.com\/v1\/products?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=name"
},
"data": [
{
"type": "products",
"id": "1",
"attributes": {
"store_id": 1,
"name": "Example Product",
"slug": "example-product",
"description": "<p>Lorem ipsum...<\/p>",
"status": "published",
"status_formatted": "Published",
"thumb_url": "https:\/\/app.lemonsqueezy.com\/storage\/media\/1\/1c40f227-aed5-4321-9ffc-62f37a06c9a0.jpg",
"large_thumb_url": "https:\/\/app.lemonsqueezy.com\/storage\/media\/1\/1c40f227-aed5-4321-9ffc-62f37a06c9a0.jpg",
"price": 999,
"pay_what_you_want": false,
"from_price": null,
"to_price": null,
"buy_now_url": "https:\/\/my-store.lemonsqueezy.com\/checkout\/buy\/0a841cf5-4cc2-4bbb-ae5d-9529d97deec6",
"price_formatted": "$9.99",
"created_at": "2021-05-27T12:54:47.000000Z",
"updated_at": "2021-07-14T11:25:24.000000Z"
},
"relationships": {
"store": {
"links": {
"related": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/store",
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/relationships\/store"
}
},
"variants": {
"links": {
"related": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/variants",
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1\/relationships\/variants"
}
}
},
"links": {
"self": "https:\/\/api.lemonsqueezy.com\/v1\/products\/1"
}
},
{...},
{...},
]
}