Lemon Squeezy API

https://docs.lemonsqueezy.com/api
Admin
The Lemon Squeezy API is a REST API for programmatic access to the Lemon Squeezy e-commerce...
Tokens:95,487
Snippets:797
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### List all prices

Source: https://docs.lemonsqueezy.com/api/prices/list-all-prices

Retrieves a paginated list of all prices using a GET request.

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

--------------------------------

### GET /v1/products/:id

Source: https://docs.lemonsqueezy.com/api/products/retrieve-product

Retrieves the product with the given ID.

```APIDOC
## GET /v1/products/:id

### Description
Retrieves the product with the given ID.

### Method
GET

### Endpoint
/v1/products/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the product to retrieve.

### Request Example
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}'

### Response
#### Success Response (200)
- **data** (object) - The Product object containing attributes and relationships.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/products/1"
  },
  "data": {
    "type": "products",
    "id": "1",
    "attributes": {
      "store_id": 1,
      "name": "Lemonade",
      "slug": "lemonade",
      "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,
      "price_formatted": "$9.99",
      "from_price": null,
      "to_price": null,
      "pay_what_you_want": false,
      "buy_now_url": "https://my-store.lemonsqueezy.com/checkout/buy/0a841cf5-4cc2-4bbb-ae5d-9529d97deec6",
      "from_price_formatted": null,
      "to_price_formatted": null,
      "created_at": "2021-05-27T12:54:47.000000Z",
      "updated_at": "2021-07-14T11:25:24.000000Z",
      "test_mode": false
    },
    "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"
    }
  }
}
```

--------------------------------

### List all subscription items

Source: https://docs.lemonsqueezy.com/api/subscription-items/list-all-subscription-items

Retrieve a list of all subscription items using a GET request.

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

--------------------------------

### List all affiliates

Source: https://docs.lemonsqueezy.com/api/affiliates/list-all-affiliates

Retrieves a paginated list of all affiliates using a GET request.

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

--------------------------------

### GET /v1/products

Source: https://docs.lemonsqueezy.com/api/products/list-all-products

Retrieves a paginated list of all products. Supports filtering by store ID.

```APIDOC
## GET /v1/products

### Description
Retrieves a paginated list of all products. The list is ordered by the name field in ascending order.

### Method
GET

### Endpoint
/v1/products

### Parameters
#### Query Parameters
- **filter[store_id]** (integer) - Optional - Filter products by the ID of the store they belong to.

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata.
- **data** (array) - A list of Product objects.

#### Response Example
{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 10,
      "to": 10,
      "total": 10
    }
  },
  "data": [
    {
      "type": "products",
      "id": "1",
      "attributes": {
        "name": "Lemonade",
        "status": "published",
        "price": 999
      }
    }
  ]
}
```

--------------------------------

### GET /v1/license-key-instances/:id

Source: https://docs.lemonsqueezy.com/api/license-key-instances/retrieve-license-key-instance

Retrieves the license key instance with the given ID.

```APIDOC
## GET /v1/license-key-instances/:id

### Description
Retrieves the license key instance with the given ID.

### Method
GET

### Endpoint
/v1/license-key-instances/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the license key instance to retrieve.

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

### Response
#### Success Response (200)
- **data** (object) - The license key instance object containing attributes like license_key_id, identifier, name, created_at, and updated_at.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/license-key-instances/1"
  },
  "data": {
    "type": "license-key-instances",
    "id": "1",
    "attributes": {
      "license_key_id": 1,
      "identifier": "f70a79fa-6054-433e-9c1b-6075344292e4",
      "name": "example.com",
      "created_at": "2022-11-14T11:45:39.000000Z",
      "updated_at": "2022-11-14T11:45:39.000000Z"
    },
    "relationships": {
      "license-key": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/license-key-instances/1/license-key",
          "self": "https://api.lemonsqueezy.com/v1/license-key-instances/1/relationships/license-key"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/license-key-instances/1"
    }
  }
}
```

--------------------------------

### Example response for list all discounts

Source: https://docs.lemonsqueezy.com/api/discounts/list-all-discounts

The API returns a paginated list of discount objects ordered by created_at in descending order.

```json
{
  "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/discounts?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=createdAt",
    "last": "https://api.lemonsqueezy.com/v1/discounts?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=createdAt"
  },
  "data": [
    {
      "type": "discounts",
      "id": "1",
      "attributes": {
        "store_id": 1,
        "name": "10%",
        "code": "10PERC",
        "amount": 10,
        "amount_type": "percent",
        "is_limited_to_products": false,
        "is_limited_redemptions": false,
        "max_redemptions": 0,
        "starts_at": null,
        "expires_at": null,
        "duration": "once",
        "duration_in_months": 1,
        "status": "published",
        "status_formatted": "Published",
        "created_at": "2021-05-24T14:15:06.000000Z",
        "updated_at": "2021-05-24T14:15:06.000000Z",
        "test_mode": false
      },
      "relationships": {
        "store": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/discounts/1/store",
            "self": "https://api.lemonsqueezy.com/v1/discounts/1/relationships/store"
          }
        },
        "variants": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/discounts/1/variants",
            "self": "https://api.lemonsqueezy.com/v1/discounts/1/relationships/variants"
          }
        },
        "discount-redemptions": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/discounts/1/discount-redemptions",
            "self": "https://api.lemonsqueezy.com/v1/discounts/1/relationships/discount-redemptions"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/discounts/1"
      }
    },
    {...},
    {...},
  ]
}
```

--------------------------------

### Custom paginated query request

Source: https://docs.lemonsqueezy.com/api/getting-started/requests

Example of a GET request using page[number] and page[size] parameters to customize pagination.

```http
GET /v1/orders?page[number]=3&page[size]=100
```

--------------------------------

### Custom Data Object Example

Source: https://docs.lemonsqueezy.com/api/checkouts/create-checkout

Example of the custom object structure for passing additional data to the checkout.

```json
"custom": {
  "user_id": "123"
}
```

--------------------------------

### Error Response Example

Source: https://docs.lemonsqueezy.com/api/license-api/activate-license-key

The JSON response returned when a license key activation fails, such as when the activation limit has been reached.

```json
{
  "activated": false,
  "error": "This license key has reached the activation limit.",
  "license_key": {
    "id": 1,
    "status": "active",
    "key": "38b1460a-5104-4067-a91d-77b872934d51",
    "activation_limit": 5,
    "activation_usage": 5,
    "created_at": "2021-01-24T14:15:07.000000Z",
    "expires_at": null
  },
  "meta": {
    "store_id": 1,
    "order_id": 2,
    "order_item_id": 3,
    "product_id": 4,
    "product_name": "Lemonade",
    "variant_id": 5,
    "variant_name": "Default",
    "customer_id": 6,
    "customer_name": "John Doe",
    "customer_email": "johndoe@example.com"
  }
}
```

--------------------------------

### Variant Quantities List Example

Source: https://docs.lemonsqueezy.com/api/checkouts/create-checkout

Example of the variant_quantities list structure containing variant IDs and their respective quantities.

```json
"variant_quantities": [
  {
    "variant_id": 123,
    "quantity": 3
  }
]
```

--------------------------------

### Product Object JSON Structure

Source: https://docs.lemonsqueezy.com/api/products/the-product-object

A complete example of the JSON structure for a Product object, showing all available attributes.

```json
{
  "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,
    "price_formatted": "$9.99",
    "from_price": null,
    "to_price": null,
    "pay_what_you_want": false,
    "buy_now_url": "https://my-store.lemonsqueezy.com/checkout/buy/0a841cf5-4cc2-4bbb-ae5d-9529d97deec6",
    "from_price_formatted": null,
    "to_price_formatted": null,
    "created_at": "2021-05-27T12:54:47.000000Z",
    "updated_at": "2021-07-14T11:25:24.000000Z",
    "test_mode": false
  }
}
```

--------------------------------

### Authenticated request example using cURL

Source: https://docs.lemonsqueezy.com/api/getting-started/requests

An example of how to authenticate a request to the /v1/users/me endpoint using a Bearer token in the Authorization header.

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

--------------------------------

### Create a basic discount

Source: https://docs.lemonsqueezy.com/api/discounts/create-discount

A standard request to create a discount by specifying the name, code, amount, and amount type.

```bash
curl -X "POST" "https://api.lemonsqueezy.com/v1/discounts" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer {api_key}" \
  -d '{
    "data": {
      "type": "discounts",
      "attributes": {
        "name": "10% Off",
        "code": "10PERCENT",
        "amount": 10,
        "amount_type": "percent"
      },
      "relationships": {
        "store": {
          "data": {
            "type": "stores",
            "id": "1"
          }
        }
      }
    }
  }'
```

--------------------------------

### GET /v1/users/me

Source: https://docs.lemonsqueezy.com/api/users/retrieve-user

Retrieves the currently authenticated user.

```APIDOC
## GET /v1/users/me

### Description
Retrieves the currently authenticated user.

### Method
GET

### Endpoint
/v1/users/me

### Response
#### Success Response (200)
- **data** (object) - The user object containing type, id, and attributes such as name, email, color, and avatar_url.

#### Response Example
{
  "meta": {
    "test_mode": true
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/users/1"
  },
  "data": {
    "type": "users",
    "id": "1",
    "attributes": {
      "name": "John Doe",
      "email": "johndoe@example.com",
      "color": "#898FA9",
      "avatar_url": "https://www.gravatar.com/avatar/1ace5b3965c59dbcd1db79d85da75048?d=blank",
      "has_custom_avatar": false,
      "createdAt": "2024-05-24T14:08:31.000000Z",
      "updatedAt": "2024-08-26T13:24:54.000000Z"
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/users/1"
    }
  }
}
```

--------------------------------

### GET /v1/orders

Source: https://docs.lemonsqueezy.com/api/orders/list-all-orders

Retrieves a paginated list of orders.

```APIDOC
## GET /v1/orders

### Description
Returns a paginated list of Order objects ordered by `created_at` in descending order.

### Method
GET

### Endpoint
https://api.lemonsqueezy.com/v1/orders

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata
- **jsonapi** (object) - JSON:API version information
- **links** (object) - Pagination links
- **data** (array) - List of order objects

#### Response Example
{
  "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/orders?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt",
    "last": "https://api.lemonsqueezy.com/v1/orders?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt"
  },
  "data": [
    {
      "type": "orders",
      "id": "1",
      "attributes": {
        "store_id": 1,
        "customer_id": 1,
        "identifier": "104e18a2-d755-4d4b-80c4-a6c1dcbe1c10",
        "status": "paid",
        "total_formatted": "$11.99",
        "created_at": "2021-08-17T09:45:53.000000Z"
      }
    }
  ]
}
```

--------------------------------

### POST /v1/licenses/activate

Source: https://docs.lemonsqueezy.com/api/license-api/activate-license-key

Activates a license key for a specific instance.

```APIDOC
## POST /v1/licenses/activate

### Description
Activates a license key. This endpoint registers a new instance for the provided license key.

### Method
POST

### Endpoint
/v1/licenses/activate

### Parameters
#### Request Body
- **license_key** (string) - Required - The license key to activate.
- **instance_name** (string) - Required - A label for the new instance to identify it in Lemon Squeezy.

### Request Example
curl -X POST https://api.lemonsqueezy.com/v1/licenses/activate \
  -H "Accept: application/json" \
  -d "license_key=38b1460a-5104-4067-a91d-77b872934d51" \
  -d "instance_name=Test"

### Response
#### Success Response (200)
- **activated** (boolean) - A boolean indicating whether the license key was successfully activated.
- **error** (string|null) - An error message if the license key could not be activated.
- **license_key** (object) - The information about the license key that was activated.
- **instance** (object) - The information about the license key instance that was created.
- **meta** (object) - Additional information about the license key, including the order, product, variant, and customer information.

#### Response Example
{
  "activated": true,
  "error": null,
  "license_key": {
    "id": 1,
    "status": "active",
    "key": "38b1460a-5104-4067-a91d-77b872934d51",
    "activation_limit": 1,
    "activation_usage": 5,
    "created_at": "2021-01-24T14:15:07.000000Z",
    "expires_at": null
  },
  "instance": {
    "id": "47596ad9-a811-4ebf-ac8a-03fc7b6d2a17",
    "name": "Test",
    "created_at": "2021-04-06T14:15:07.000000Z"
  },
  "meta": {
    "store_id": 1,
    "order_id": 2,
    "order_item_id": 3,
    "product_id": 4,
    "product_name": "Example Product",
    "variant_id": 5,
    "variant_name": "Default",
    "customer_id": 6,
    "customer_name": "John Doe",
    "customer_email": "johndoe@example.com"
  }
}
```

--------------------------------

### Example response with included resources

Source: https://docs.lemonsqueezy.com/api/getting-started/requests

Shows the structure of an API response containing an included array of related resources.

```json
{
  "meta": {
    ...
  },
  "jsonapi": {
    ...
  },
  "links": {
    ...
  },
  "data": [
    {...},
    {...},
    {...}
  ],
  "included": [
    {
      "type": "variants",
      "id": "1",
      "attributes": {
        "product_id": 1,
        "name": "Default",
        "slug": "537b22ba-fcc9-452a-9021-c3cabe3985cf",
        "description": "<p>This is the variant description.</p>",
        "links": [],
        "price": 999,
        "is_subscription": true,
        "interval": "month",
        "interval_count": 1,
        "has_free_trial": false,
        "trial_interval": "day",
        "trial_interval_count": 30,
        "pay_what_you_want": false,
        "min_price": 0,
        "suggested_price": 0,
        "has_license_keys": false,
        "license_activation_limit": 5,
        "is_license_limit_unlimited": false,
        "license_length_value": 1,
        "license_length_unit": "years",
        "is_license_length_unlimited": false,
        "sort": 0,
        "status": "pending",
        "status_formatted": "Pending",
        "created_at": "2021-05-27T12:54:47.000000Z",
        "updated_at": "2021-07-14T11:25:24.000000Z",
        "test_mode": false
      },
      "relationships": {
        "product": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/variants/1/product",
            "self": "https://api.lemonsqueezy.com/v1/variants/1/relationships/product"
          }
        },
        "files": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/variants/1/files",
            "self": "https://api.lemonsqueezy.com/v1/variants/1/relationships/files"
          }
        },
        "price-model": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/variants/1/price-model",
            "self": "https://api.lemonsqueezy.com/v1/variants/1/relationships/price-model"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/variants/1"
      }
    },
    {...},
    {...}
  ]
}
```

--------------------------------

### GET /v1/webhooks/:id

Source: https://docs.lemonsqueezy.com/api/webhooks/retrieve-webhook

Retrieves the webhook with the given ID.

```APIDOC
## GET /v1/webhooks/:id

### Description
Retrieves the webhook with the given ID.

### Method
GET

### Endpoint
/v1/webhooks/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the webhook to retrieve.

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

### Response
#### Success Response (200)
- **data** (object) - The Webhook object.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/webhooks/1"
  },
  "data": {
    "type": "webhooks",
    "id": "1",
    "attributes": {
      "store_id": 1,
      "url": "https://mysite.com/webhooks/",
      "events": [
        "order_created",
        "subscription_created",
        "subscription_updated",
        "subscription_expired"
      ],
      "last_sent_at": "2022-11-22T07:38:06.000000Z",
      "created_at": "2022-06-07T08:32:47.000000Z",
      "updated_at": "2022-06-07T08:32:47.000000Z",
      "test_mode": false
    },
    "relationships": {
      "store": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/webhooks/1/store",
          "self": "https://api.lemonsqueezy.com/v1/webhooks/1/relationships/store"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/webhooks/1"
    }
  }
}
```

--------------------------------

### GET /v1/variants/:id

Source: https://docs.lemonsqueezy.com/api/variants/retrieve-variant

Retrieves the variant with the given ID.

```APIDOC
## GET /v1/variants/:id

### Description
Retrieves the variant with the given ID.

### Method
GET

### Endpoint
/v1/variants/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the variant.

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

### Response
#### Success Response (200)
- **data** (object) - The Variant object containing attributes and relationships.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/variants/1"
  },
  "data": {
    "type": "variants",
    "id": "1",
    "attributes": {
      "product_id": 1,
      "name": "Citrus Burst Lemonade",
      "slug": "46beb127-a8a9-33e6-89b5-078505657239",
      "description": "<p>Lorem ipsum...</p>",
      "price": 999,
      "status": "published",
      "created_at": "2024-05-24T14:15:06.000000Z",
      "updated_at": "2024-06-24T14:44:38.000000Z"
    }
  }
}
```

--------------------------------

### Create a Customer Request

Source: https://docs.lemonsqueezy.com/api/customers/create-customer

Use this cURL command to send a POST request to the /v1/customers endpoint. Replace {api_key} with your actual Lemon Squeezy API key.

```bash
curl -X "POST" "https://api.lemonsqueezy.com/v1/customers" \
  -H 'Accept: application/vnd.api+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {api_key}' \
  -d $'{
  "data": {
    "type": "customers",
    "attributes": {
      "name": "John Doe",
      "email": "johndoe@example.com",
      "city": "New York",
      "region": "NY",
      "country": "US"
    },
    "relationships": {
      "store": {
        "data": {
          "type": "stores",
          "id": "1"
        }
      }
    }
  }
}'
```

--------------------------------

### List all products via cURL

Source: https://docs.lemonsqueezy.com/api/products/list-all-products

Retrieves a paginated list of all products using a GET request.

```bash
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}'
```

--------------------------------

### GET /v1/subscriptions/:id

Source: https://docs.lemonsqueezy.com/api/subscriptions/retrieve-subscription

Retrieves the subscription with the given ID.

```APIDOC
## GET /v1/subscriptions/:id

### Description
Retrieves the subscription with the given ID.

### Method
GET

### Endpoint
/v1/subscriptions/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the subscription to retrieve.

### Response
#### Success Response (200)
- **data** (object) - The Subscription object containing attributes and relationships.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/subscriptions/1"
  },
  "data": {
    "type": "subscriptions",
    "id": "1",
    "attributes": {
      "store_id": 1,
      "customer_id": 1,
      "order_id": 1,
      "order_item_id": 1,
      "product_id": 1,
      "variant_id": 1,
      "product_name": "Lemonade",
      "variant_name": "Citrus Blast",
      "user_name": "John Doe",
      "user_email": "johndoe@example.com",
      "status": "active",
      "status_formatted": "Active",
      "card_brand": "visa",
      "card_last_four": "4242",
      "payment_processor": "stripe",
      "pause": null,
      "cancelled": false,
      "trial_ends_at": null,
      "billing_anchor": 12,
      "first_subscription_item": {
        "id": 1,
        "subscription_id": 1,
        "price_id": 1,
        "quantity": 5,
        "created_at": "2021-08-11T13:47:28.000000Z",
        "updated_at": "2021-08-11T13:47:28.000000Z"
      },
      "urls": {
        "update_payment_method": "https://my-store.lemonsqueezy.com/subscription/1/payment-details?expires=1666869343&signature=9985e3bf9007840aeb3951412be475abc17439c449c1af3e56e08e45e1345413",
        "customer_portal": "https://my-store.lemonsqueezy.com/billing?expires=1666869343&signature=82ae290ceac8edd4190c82825dd73a8743346d894a8ddbc4898b97eb96d105a5"
      },
      "renews_at": "2022-11-12T00:00:00.000000Z",
      "ends_at": null,
      "created_at": "2021-08-11T13:47:27.000000Z",
      "updated_at": "2021-08-11T13:54:19.000000Z",
      "test_mode": false
    }
  }
}
```

--------------------------------

### GET /v1/stores/:id

Source: https://docs.lemonsqueezy.com/api/stores/retrieve-store

Retrieves the store with the given ID.

```APIDOC
## GET /v1/stores/:id

### Description
Retrieves the store with the given ID.

### Method
GET

### Endpoint
/v1/stores/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the store to retrieve.

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

### Response
#### Success Response (200)
- **data** (object) - Returns a Store object containing attributes such as name, slug, domain, and financial metrics.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/stores/1"
  },
  "data": {
    "type": "stores",
    "id": "1",
    "attributes": {
      "name": "My Store",
      "slug": "my-store",
      "domain": "my-store.lemonsqueezy.com",
      "url": "https://my-store.lemonsqueezy.com",
      "avatar_url": "https://app.lemonsqueezy.com/storage/avatars/stores/1/czTkMkDm4Vfb8PZehb5c29XFCm9JZyJx0AjEZP7s.png",
      "plan": "fresh",
      "country": "US",
      "country_nicename": "United States",
      "currency": "USD",
      "total_sales": 1,
      "total_revenue": 999,
      "thirty_day_sales": 0,
      "thirty_day_revenue": 0,
      "created_at": "2021-05-24T14:15:06.000000Z",
      "updated_at": "2021-06-15T10:03:14.000000Z"
    }
  }
}
```

--------------------------------

### Create a discount limited to specific variants

Source: https://docs.lemonsqueezy.com/api/discounts/create-discount

An example of creating a discount that is restricted to specific product variants by setting is_limited_to_products to true and providing the variant IDs in the relationships object.

```bash
curl -X "POST" "https://api.lemonsqueezy.com/v1/discounts" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer {api_key}" \
  -d '{
    "data": {
      "type": "discounts",
      "attributes": {
        "name": "10% Off",
        "code": "10PERCENT",
        "amount": 10,
        "amount_type": "percent",
        "is_limited_to_products": true
      },
      "relationships": {
        "store": {
          "data": {
            "type": "stores",
            "id": "1"
          }
        },
        "variants": {
          "data": [
            {
              "type": "variants",
              "id": "3"
            },
            {
              "type": "variants",
              "id": "4"
            }
          ]
        }
      }
    }
  }'
```

--------------------------------

### List all license key instances

Source: https://docs.lemonsqueezy.com/api/license-key-instances/list-all-license-key-instances

Retrieves a paginated list of all license key instances using a cURL request.

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

--------------------------------

### Retrieve a store via cURL

Source: https://docs.lemonsqueezy.com/api/stores/retrieve-store

Use this cURL command to fetch a store by its ID. Replace {api_key} with your actual Lemon Squeezy API key.

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

--------------------------------

### GET /v1/prices/:id

Source: https://docs.lemonsqueezy.com/api/prices/retrieve-price

Retrieves the price with the given ID.

```APIDOC
## GET /v1/prices/:id

### Description
Retrieves the price with the given ID.

### Method
GET

### Endpoint
/v1/prices/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the price to retrieve.

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

### Response
#### Success Response (200)
- **data** (object) - The Price object containing attributes and relationships.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/prices/1"
  },
  "data": {
    "type": "prices",
    "id": "1",
    "attributes": {
      "variant_id": 1,
      "category": "subscription",
      "scheme": "graduated",
      "usage_aggregation": null,
      "unit_price": 999,
      "unit_price_decimal": null,
      "setup_fee_enabled": false,
      "setup_fee": null,
      "package_size": 1,
      "tiers": [
        {
          "last_unit": 2,
          "unit_price": 10000,
          "unit_price_decimal": null,
          "fixed_fee": 1000
        },
        {
          "last_unit": "inf",
          "unit_price": 1000,
          "unit_price_decimal": null,
          "fixed_fee": 1000
        }
      ],
      "renewal_interval_unit": "year",
      "renewal_interval_quantity": 1,
      "trial_interval_unit": "day",
      "trial_interval_quantity": 30,
      "min_price": null,
      "suggested_price": null,
      "tax_code": "eservice",
      "created_at": "2023-05-24T14:15:06.000000Z",
      "updated_at": "2023-06-24T14:44:38.000000Z"
    },
    "relationships": {
      "variant": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/prices/1/variant",
          "self": "https://api.lemonsqueezy.com/v1/prices/1/relationships/variant"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/prices/1"
    }
  }
}
```

--------------------------------

### GET /v1/orders/:id

Source: https://docs.lemonsqueezy.com/api/orders/retrieve-order

Retrieves the order with the given ID.

```APIDOC
## GET /v1/orders/:id

### Description
Retrieves the order with the given ID.

### Method
GET

### Endpoint
/v1/orders/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the order.

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

### Response
#### Success Response (200)
- **data** (object) - The Order object containing attributes and relationships.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "orders",
    "id": "1",
    "attributes": {
      "store_id": 1,
      "user_name": "John Doe",
      "total": 1199,
      "status": "paid"
    }
  }
}
```

--------------------------------

### GET /v1/files/:id

Source: https://docs.lemonsqueezy.com/api/files/retrieve-file

Retrieves the file with the given ID.

```APIDOC
## GET /v1/files/:id

### Description
Retrieves the file with the given ID.

### Method
GET

### Endpoint
/v1/files/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the file to retrieve.

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

### Response
#### Success Response (200)
- **data** (object) - The File object containing file attributes and relationships.

#### Response Example
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/files/1"
  },
  "data": {
    "type": "files",
    "id": "1",
    "attributes": {
      "variant_id": 168,
      "identifier": "6dce5ba7-76f2-481f-ad1e-9c2bec6eb0e2",
      "name": "lemonade.zip",
      "extension": "zip",
      "download_url": "https://app.lemonsqueezy.com/download/6dce5ba7-76f2-481f-ad1e-9c2bec6eb0e2?expires=1636384018&signature=f0a9bdec44ffabf143d4689594491f42a76d773d3cc88ec23ef84d6e903e8f11",
      "size": 874694,
      "size_formatted": "854 KB",
      "version": "1.0.0",
      "sort": 1,
      "status": "published",
      "createdAt": "2024-11-05T10:22:14.000000Z",
      "updatedAt": "2024-11-05T16:16:33.000000Z",
      "test_mode": false
    },
    "relationships": {
      "variant": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/files/1/variant",
          "self": "https://api.lemonsqueezy.com/v1/files/1/relationships/variant"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/files/1"
    }
  }
}
```

--------------------------------

### GET /v1/license-key-instances

Source: https://docs.lemonsqueezy.com/api/license-key-instances/list-all-license-key-instances

Returns a paginated list of license key instances, ordered by ID in descending order.

```APIDOC
## GET /v1/license-key-instances

### Description
Returns a paginated list of license key instances. Results are ordered by ID in descending order.

### Method
GET

### Endpoint
/v1/license-key-instances

### Parameters
#### Query Parameters
- **filter[license_key_id]** (integer) - Optional - Only return instances belonging to the license key with this ID.

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata.
- **data** (array) - A list of license key instance objects.
```

--------------------------------

### Query Variants for a specific Product

Source: https://docs.lemonsqueezy.com/api/getting-started/requests

This example demonstrates how to retrieve all Variants associated with a specific Product using a nested query URL.

```http
GET /v1/products/100/variants
```
Tokens:
Raw