Lemon Squeezy

https://docs.lemonsqueezy.com/
Admin
Lemon Squeezy is an e-commerce platform and Merchant of Record (MoR) solution that simplifies...
Tokens:250,127
Snippets:1,999
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example response for listing products

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

Shows the JSON response structure returned by the GET /v1/products endpoint, including pagination metadata and product data.

```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/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": "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",
        "created_at": "2024-05-27T12:54:47.000000Z",
        "updated_at": "2024-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"
      }
    },
    {...},
    {...}
  ]
}

```

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

### Example response for list all prices

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

Example JSON response showing the paginated list of Price objects, including metadata, links, and data array.

```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/prices?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-created_at",
    "last": "https://api.lemonsqueezy.com/v1/prices?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-created_at"
  },
  "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"
      }
    },
    {...},
    {...},
  ]
}

```

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

### Install Express and Lemon Squeezy SDK

Source: https://docs.lemonsqueezy.com/guides/tutorials/in-app-purchases

Install the required npm packages for the Express server and the Lemon Squeezy JavaScript SDK.

```bash
npm install express @lemonsqueezy/lemonsqueezy.js

```

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

### Update License Key Response Example

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

Example response returned after updating a license key. Shows the updated License Key object with its attributes and relationships. Note that the response example uses subscription-item data, which may not match the actual license key response.

```json
{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/subscription-item/1"
  },
  "data": {
    "type": "subscription-items",
    "id": "1",
    "attributes": {
      "subscription_id": 1,
      "price_id": 1,
      "quantity": 10,
      "is_usage_based": false,
      "created_at": "2023-07-18T12:16:24.000000Z",
      "updated_at": "2023-07-18T12:23:18.000000Z"
    },
    "relationships": {
      "subscription": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/subscription-items/1/subscription",
          "self": "https://api.lemonsqueezy.com/v1/subscription-items/1/relationships/subscription"
        }
      },
      "price": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/subscription-items/1/price",
          "self": "https://api.lemonsqueezy.com/v1/subscription-items/1/relationships/price"
        }
      },
      "usage-records": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/subscription-items/1/usage-records",
          "self": "https://api.lemonsqueezy.com/v1/subscription-items/1/relationships/usage-records"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/subscription-items/1"
    }
  }
}
```

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

### Install lemonsqueezy.js SDK

Source: https://docs.lemonsqueezy.com/guides/tutorials/nextjs-saas-billing

Installs the official Lemon Squeezy JS SDK using PNPM. The SDK fully covers the Lemon Squeezy API.

```bash
pnpm install @lemonsqueezy/lemonsqueezy.js

```

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

### Example response for List All Customers

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

Example JSON response from the List All Customers endpoint. Shows pagination metadata, links, and a customer object with attributes and relationships.

```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/customers?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt",
    "last": "https://api.lemonsqueezy.com/v1/customers?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt"
  },
  "data": [
    {
      "type": "customers",
      "id": "1",
      "attributes": {
        "store_id": 1,
        "name": "John Doe",
        "email": "johndoe@example.com",
        "status": "subscribed",
        "city": null,
        "region": null,
        "country": "US",
        "total_revenue_currency": 84332,
        "mrr": 1999,
        "status_formatted": "Subscribed",
        "country_formatted": "United States",
        "total_revenue_currency_formatted": "$843.32",
        "mrr_formatted": "$19.99",
        "urls": {
          "customer_portal": "https://my-store.lemonsqueezy.com/billing?expires=1666869343&signature=82ae290ceac8edd4190c82825dd73a8743346d894a8ddbc4898b97eb96d105a5"
        },
        "created_at": "2024-12-01T13:01:07.000000Z",
        "updated_at": "2024-12-09T09:05:21.000000Z",
        "test_mode": false
      },
      "relationships": {
        "store": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/customers/1/store",
            "self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/store"
          }
        },
        "affiliates": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/customers/1/affiliates",
            "self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/affiliates"
          }
        },
        "orders": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/customers/1/orders",
            "self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/orders"
          }
        },
        "subscriptions": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/customers/1/subscriptions",
            "self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/subscriptions"
          }
        },
        "license-keys": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/customers/1/license-keys",
            "self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/license-keys"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/customers/1"
      }
    },
    {...},
    {...}
  ]
}

```

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

### Example response for listing discount redemptions

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

Example response for the list endpoint. Shows pagination metadata and a discount redemption object with attributes and relationships.

```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/discount-redemptions?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt",
    "last": "https://api.lemonsqueezy.com/v1/discount-redemptions?page%5Bnumber%5D=1339&page%5Bsize%5D=10&sort=-createdAt",
    "next": "https://api.lemonsqueezy.com/v1/discount-redemptions?page%5Bnumber%5D=2&page%5Bsize%5D=10&sort=-createdAt"
  },
  "data": [
    {
      "type": "discount-redemptions",
      "id": "1",
      "attributes": {
        "discount_id": 1,
        "order_id": 1,
        "discount_name": "10%",
        "discount_code": "10PERC",
        "discount_amount": 10,
        "discount_amount_type": "percent",
        "amount": 999,
        "created_at": "2023-02-07T10:30:01.000000Z",
        "updated_at": "2023-02-07T10:30:01.000000Z"
      },
      "relationships": {
        "discount": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/discount-redemptions/1/discount",
            "self": "https://api.lemonsqueezy.com/v1/discount-redemptions/1/relationships/discount"
          }
        },
        "order": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/discount-redemptions/1/order",
            "self": "https://api.lemonsqueezy.com/v1/discount-redemptions/1/relationships/order"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/discount-redemptions/1"
      }
    },
    {...},
    {...},
  ]
}

```

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

### LemonSqueezy.Setup(options)

Source: https://docs.lemonsqueezy.com/help/lemonjs/methods

Initializes Lemon.js on your page with optional event handler.

```APIDOC
## LemonSqueezy.Setup(options)

### Description
Initializes Lemon.js on your page. Accepts an options object with an optional eventHandler callback.

### Method
Setup

### Parameters
#### Request Body
- **options** (object) - Required - An object containing setup options.
  - **eventHandler** (function) - Optional - Callback function that receives event data.

### Request Example
```javascript
LemonSqueezy.Setup({
  eventHandler: (event) => {
    // Do whatever you want with this event data
  }
})
```

### Response
No response value is returned.
```

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

### List all order items response example

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

Example JSON response from the GET /v1/order-items endpoint, showing pagination metadata, links, and an array of order item objects with attributes and relationships.

```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/order-items?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id",
    "last": "https://api.lemonsqueezy.com/v1/order-items?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id"
  },
  "data": [
    {
      "type": "order-items",
      "id": "1",
      "attributes": {
        "order_id": 1,
        "product_id": 1,
        "variant_id": 1,
        "product_name": "Lemonade",
        "variant_name": "Citrus Blast",
        "price": 999,
        "quantity": 1,
        "created_at": "2021-05-24T14:15:06.000000Z",
        "updated_at": "2021-05-24T14:15:06.000000Z"
      },
      "relationships": {
        "order": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/order-items/1/order",
            "self": "https://api.lemonsqueezy.com/v1/order-items/1/relationships/order"
          }
        },
        "product": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/order-items/1/product",
            "self": "https://api.lemonsqueezy.com/v1/order-items/1/relationships/product"
          }
        },
        "variant": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/order-items/1/variant",
            "self": "https://api.lemonsqueezy.com/v1/order-items/1/relationships/variant"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/order-items/1"
      }
    },
    {...},
    {...},
  ]
}

```

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

### Sample JSON response for listing license key instances

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

Example response showing the paginated structure with meta, links, and data array containing license key instance objects.

```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/license-key-instances?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id",
    "last": "https://api.lemonsqueezy.com/v1/license-key-instances?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id"
  },
  "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"
      }
    },
    {...},
    {...},
  ]
}

```

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

### GET /v1/products/100/variants - Nested query example

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

Use this nested query to retrieve all variants for a specific product. The request URL is found in the product's relationships object.

```http
GET /v1/products/100/variants

```

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

### Set up Lemon Squeezy SDK in Express

Source: https://docs.lemonsqueezy.com/guides/tutorials/in-app-purchases

Initialize the Lemon Squeezy SDK with your API key from environment variables.

```javascript
lemonSqueezySetup({ 
  apiKey: process.env.LEMONSQUEEZY_API_KEY 
});

```

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

### GET /products endpoint with variant relationship URLs

Source: https://docs.lemonsqueezy.com/guides/tutorials/api-related-resources

Example request and response from the `/products` endpoint. The response shows the `data.relationships.variants.links` object with `related` and `self` URLs for each product, which can be used to query each product's variants.

```http
GET https://api.lemonsqueezy.com/v1/products
```

```json
{
  ...
  "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,
        "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",
        "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"
      }
    },
    {...},
    {...}
  ]
  ...
}
```

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

### Custom paginated query with page[size] and page[number]

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

Example of a GET request using page[number] and page[size] parameters to retrieve a specific page with a custom page size. Default page size is 10, minimum 1, maximum 100.

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

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

### Create checkout and open Lemon.js modal with SignupButton and getCheckoutURL

Source: https://docs.lemonsqueezy.com/guides/tutorials/nextjs-saas-billing

The SignupButton component creates a checkout via getCheckoutURL and opens it in a Lemon.js modal (or redirects). The getCheckoutURL server action configures Lemon Squeezy, authenticates the user, and calls createCheckout with the store ID and variant ID, returning the checkout URL. Requires the Lemon Squeezy SDK to be enqueued and the LEMONSQUEEZY_STORE_ID and NEXT_PUBLIC_APP_URL environment variables set.

```tsx
/* /components/dashboard/billing/plans/signup-button.tsx */
 
'use client'
 
import { useState } from 'react'
import { useRouter } from 'next/navigation'
import { Button, Loading } from '@lemonsqueezy/wedges'
import { getCheckoutURL } from '@/app/actions'
 
export function SignupButton(props: {
  plan: NewPlan
  currentPlan?: NewPlan
  embed?: boolean
}) {
  const { plan, currentPlan, embed = true } = props
  const router = useRouter()
  const [loading, setLoading] = useState(false)
  const isCurrent = plan.id === currentPlan?.id
 
  const label = isCurrent ? 'Your plan' : 'Sign up'
 
  // Make sure Lemon.js is loaded, you need to enqueue the Lemon Squeezy SDK in your app first.
  useEffect(() => {
    if (typeof window.createLemonSqueezy === 'function') {
      window.createLemonSqueezy()
    }
  }, [])
 
  return (
    <Button
      before={loading ? <Loading /> : null}
      disabled={loading || isCurrent}
      onClick={() => {
        // Create a checkout and open the Lemon.js modal
        let checkoutUrl: string | undefined = ''
 
        try {
          setLoading(true)
          checkoutUrl = await getCheckoutURL(plan.variantId, embed)
        } catch (error) {
          setLoading(false)
          toast('Error creating a checkout.', {
            description:
              'Please check the server console for more information.',
          })
        } finally {
          embed && setLoading(false)
        }
 
        embed
          ? checkoutUrl && window.LemonSqueezy.Url.Open(checkoutUrl)
          : router.push(checkoutUrl ?? '/')
      }}
    >
      {label}
    </Button>
  )
}

```

```typescript
export async function getCheckoutURL(variantId: number, embed = false) {
  configureLemonSqueezy()
 
  const session = await auth()
 
  if (!session?.user) {
    throw new Error('User is not authenticated.')
  }
 
  // import { createCheckout } from '@lemonsqueezy/lemonsqueezy.js'
  const checkout = await createCheckout(
    process.env.LEMONSQUEEZY_STORE_ID!,
    variantId,
    {
      checkoutOptions: {
        embed,
        media: false,
        logo: !embed,
      },
      checkoutData: {
        email: session.user.email ?? undefined,
        custom: {
          user_id: session.user.id,
        },
      },
      productOptions: {
        enabledVariants: [variantId],
        redirectUrl: `${process.env.NEXT_PUBLIC_APP_URL}/billing/`,
        receiptButtonText: 'Go to Dashboard',
        receiptThankYouNote: 'Thank you for signing up to Lemon Stand!',
      },
    }
  )
 
  return checkout.data?.data.attributes.url
}

```

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

### Example checkout link

Source: https://docs.lemonsqueezy.com/help/checkout/prefilled-checkout-fields

Example of a real checkout link with a store name and variant ID.

```text
https://my-store.lemonsqueezy.com/checkout/buy/d1f120fd-5adc-4fff-8915-cce713d29427

```

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

### List All Webhooks response example

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

Example response from the List All Webhooks endpoint. Returns a paginated list of Webhook objects ordered by created_at descending, with pagination metadata in meta.page.

```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/webhooks?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt",
    "last": "https://api.lemonsqueezy.com/v1/webhooks?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt"
  },
  "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"
    }
  }
}

```

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

### Order item object example

Source: https://docs.lemonsqueezy.com/api/order-items

Example JSON representation of an order item object with all its attributes.

```json
{
  "type": "order-items",
  "id": "1",
  "attributes": {
    "order_id": 1,
    "product_id": 1,
    "variant_id": 1,
    "product_name": "Lemonade",
    "variant_name": "Citrus Blast",
    "price": 999,
    "quantity": 1,
    "created_at": "2021-05-24T14:15:06.000000Z",
    "updated_at": "2021-05-24T14:15:06.000000Z"
  }
}
```

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

### JSON:API error response example

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

Example of a 4xx error response. It contains a JSON:API errors array with fields like detail, status, and title. This particular example shows a 401 Unauthorized error.

```json
{
  "jsonapi": {
    "version": "1.0"
  },
  "errors": [
    {
      "detail": "Unauthenticated.",
      "status": "401",
      "title": "Unauthorized"
    }
  ]
}

```

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

### Error Response Example

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

Example error response when the license key cannot be activated, such as when the activation limit is reached. Shows activated false and an error message, with the license_key and meta objects still included.

```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"
  }
}
```

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

### Event object example

Source: https://docs.lemonsqueezy.com/guides/developer-guide/lemonjs

Example event object passed to the event handler, containing an event property.

```json
{
  event: "PaymentMethodUpdate.Closed"
}
```

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

### User object JSON example

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

Example JSON representation of a User object, showing all attributes with sample values.

```json
{
  "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"
  }
}
```

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

### Authenticated Request Example

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

Example of an authenticated request to the Lemon Squeezy API, showing the required headers and authentication method.

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

### Description
Retrieves the authenticated user's information. This endpoint is used to verify authentication and get details about the current API key owner.

### Method
GET

### Endpoint
https://api.lemonsqueezy.com/v1/users/me

### Parameters
#### Headers
- **Accept** (string) - Required - Must be `application/vnd.api+json`
- **Content-Type** (string) - Required - Must be `application/vnd.api+json`
- **Authorization** (string) - Required - Bearer token with your API key

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

### Response
#### Success Response (200)
Returns the authenticated user's details in JSON:API format.

#### Response Example
(Not provided in source)

```

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

### Variant quantities list example

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

Example of the variant_quantities list, containing objects with a variant ID and quantity value, both integers.

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

```

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

### Discount Redemption Object Example

Source: https://docs.lemonsqueezy.com/api/discount-redemptions/the-discount-redemption-object

Example JSON representation of a discount redemption object, showing the attributes returned by the API.

```json
{
  "type": "discount-redemptions",
  "id": "1",
  "attributes": {
    "discount_id": 1,
    "order_id": 1,
    "discount_name": "10%",
    "discount_code": "10PERC",
    "discount_amount": 10,
    "discount_amount_type": "percent",
    "amount": 999,
    "created_at": "2024-02-07T10:30:01.000000Z",
    "updated_at": "2024-02-07T10:30:01.000000Z"
  }
}
```
Tokens:
Raw