Lemon Squeezy tools
The 12 Lemon Squeezy operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List storesGETLists the stores of the user by name, with domain, currency, total sales and revenue in cents. The id of a store goes in the store relationship of Create customer, Create discount and Create checkout. Only the first 10 come back.
- List productsGETLists the products of every store of the user by name, with status, price range, buy_now_url and store_id. Only the first 10 come back; meta.page.total has the count. List product variants returns the variants that checkouts and discounts use.
- List product variantsGETLists the variants of a product with price in cents, subscription interval, free trial and status. The id of a variant goes in Create checkout and in the variants of Create discount. Only the first 10 come back.
- List ordersGETLists the 10 newest orders of every store of the user, with order_number, buyer name and email, status, totals in cents, refunds and receipt URL. Older orders are only reachable by id in Get order; meta.page.total has the count.
- Get orderGETReturns an order: order_number, buyer, status, currency, subtotal, discount, tax, total and refunded amount in cents, the first order item and the receipt URL.
- List customersGETLists the 10 newest customers of every store of the user, with name, email, marketing status (subscribed, unsubscribed, archived, requires_verification, invalid_email or bounced), MRR and total revenue in cents. meta.page.total has the count.
- Create customerPOSTCreates a customer in a store and returns it. The fields go inside data, as JSON:API: type, attributes with name and email, and the store in relationships.
- Update customerPATCHChanges a customer and returns it. The fields go inside data, as JSON:API, with the same id as customer_id. Only the attributes sent change; status archived stops the marketing emails.
- List subscriptionsGETLists the 10 newest subscriptions of every store of the user, with product, variant, customer email, status (on_trial, active, paused, past_due, unpaid, cancelled or expired), renews_at, ends_at and order_id. meta.page.total has the count.
- List discountsGETLists the discount codes of every store of the user, oldest first, with code, amount, amount_type, redemption limit, dates and status. Only the first 10 come back; meta.page.total has the count.
- Create discountPOSTCreates a discount code for a store and returns it. The fields go inside data, as JSON:API: type, attributes and the store in relationships, plus the variants when is_limited_to_products is true.
- Create checkoutPOSTCreates a checkout link for a variant, optionally with custom price, prefilled buyer data, discount code and expiry, and returns it with the link in data.attributes.url. The fields go inside data, as JSON:API: type, attributes, and the store and variant in relationships.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
