Lemon Squeezy Integration
Lemon Squeezy API Operations
Browse all 60 operations available for Lemon Squeezy workflow automation.
Affiliates
2 operations/v1/affiliatesList all affiliates
Retrieve a paginated list of affiliates across your stores. Use this to monitor your affiliate program, track partner activity, or sync affiliate data with external tools.
/v1/affiliates/{id}Retrieve an affiliate
Fetch details for a specific affiliate by ID. Returns the affiliate's status, earnings, and associated store information.
Checkouts
3 operations/v1/checkoutsCreate a checkout
Create a custom checkout link for a product or variant
/v1/checkoutsList all checkouts
Retrieve a paginated list of checkouts. Use this to review pending or completed checkout sessions, track conversion rates, or audit purchase flows.
/v1/checkouts/{id}Retrieve a checkout
Fetch details for a specific checkout session by ID. Returns the checkout's status, associated product variant, and any custom data attached during creation.
Customers
4 operations/v1/customersCreate a customer
Create a new customer record
/v1/customersList all customers
List all customers with optional filters
/v1/customers/{id}Retrieve a customer
Fetch details for a specific customer by ID. Returns the customer's name, email, purchase history, and subscription status.
/v1/customers/{id}Update a customer
Update a customer's name, email, or metadata
Discount Redemptions
2 operations/v1/discount-redemptionsList all discount redemptions
Retrieve a paginated list of discount redemptions. Use this to track how often discount codes are being used and by which customers, helping you measure promotion effectiveness.
/v1/discount-redemptions/{id}Retrieve a discount redemption
Fetch details for a specific discount redemption by ID. Returns the associated discount code, the order it was applied to, and the customer who redeemed it.
Discounts
4 operations/v1/discountsCreate a discount
Create a percentage or fixed-amount discount code
/v1/discounts/{id}Delete a discount
Permanently remove a discount code. Use this to clean up expired or no-longer-needed promotions. Existing orders that used this discount are not affected.
/v1/discountsList all discounts
Retrieve a paginated list of discount codes. Use this to audit active promotions, check usage limits, or export discount data for reporting.
/v1/discounts/{id}Retrieve a discount
Fetch details for a specific discount by ID. Returns the discount's code, type, amount, usage count, and any restrictions on products or expiration.
Files
2 operations/v1/filesList all files
Retrieve a paginated list of files associated with your products. Use this to audit downloadable assets, check file sizes, or verify that the correct files are attached to each product.
/v1/files/{id}Retrieve a file
Fetch details for a specific file by ID. Returns the file's name, size, download URL, and the product variant it belongs to.
License API
3 operations/v1/licenses/activateActivate a license key
Activate a license key for a specific instance
/v1/licenses/deactivateDeactivate a license key
Deactivate a license key instance
/v1/licenses/validateValidate a license key
Check if a license key is valid and active
License Key Instances
2 operations/v1/license-key-instancesList all license key instances
Retrieve a paginated list of license key activations. Each instance represents a device or environment where a license key has been activated. Use this to monitor activation counts and detect abuse.
/v1/license-key-instances/{id}Retrieve a license key instance
Fetch details for a specific license key activation by ID. Returns the instance name, the parent license key, and when the activation occurred.
License Keys
3 operations/v1/license-keysList all license keys
List all license keys across products
/v1/license-keys/{id}Retrieve a license key
Fetch details for a specific license key by ID. Returns the key value, activation limit, current activation count, expiration date, and disabled status.
/v1/license-keys/{id}Update a license key
Update activation limits, expiration, or status of a license key
Order Items
2 operations/v1/order-itemsList all order items
Retrieve a paginated list of individual line items across all orders. Use this to analyze which product variants are selling most, or to build detailed sales reports.
/v1/order-items/{id}Retrieve an order item
Fetch details for a specific order line item by ID. Returns the product, variant, price, quantity, and the parent order it belongs to.
Orders
4 operations/v1/orders/{id}/generate-invoiceGenerate an order invoice
Generate a downloadable PDF invoice for an order
/v1/orders/{id}/refundIssue a refund for an order
Process a full or partial refund for an order
/v1/ordersList all orders
List all orders with optional filters
/v1/orders/{id}Retrieve an order
Get full details of a specific order
Prices
2 operations/v1/pricesList all prices
Retrieve a paginated list of prices across your products. Use this to audit pricing tiers, compare pricing across variants, or export price data for external analysis.
/v1/prices/{id}Retrieve a price
Fetch details for a specific price by ID. Returns the amount, currency, billing interval, and the product variant it belongs to.
Products
2 operations/v1/productsList all products
Retrieve a paginated list of products in your store. Use this to sync your product catalog, generate inventory reports, or display products in an external storefront.
/v1/products/{id}Retrieve a product
Fetch details for a specific product by ID. Returns the product's name, description, pricing, variants, and associated store information.
Stores
2 operations/v1/storesList all stores
Retrieve a paginated list of your Lemon Squeezy stores. Use this to manage multi-store setups or to look up store IDs for filtering other resources.
/v1/stores/{id}Retrieve a store
Fetch details for a specific store by ID. Returns the store's name, currency, URL, and total revenue metrics.
Subscription Invoices
4 operations/v1/subscription-invoices/{id}/generate-invoiceGenerate a subscription invoice PDF
Generate a downloadable PDF invoice for a subscription payment. Use this to provide customers with formal billing documentation for recurring charges.
/v1/subscription-invoices/{id}/refundIssue a refund for a subscription invoice
Process a full or partial refund for a subscription invoice. Specify the refund amount for a partial refund, or omit it to refund the full invoice amount.
/v1/subscription-invoicesList all subscription invoices
Retrieve a paginated list of subscription invoices. Use this to track recurring billing history, identify failed payments, or reconcile subscription revenue.
/v1/subscription-invoices/{id}Retrieve a subscription invoice
Fetch details for a specific subscription invoice by ID. Returns the invoice status, amount, billing reason, and the associated subscription.
Subscription Items
4 operations/v1/subscription-itemsList all subscription items
Retrieve a paginated list of subscription line items. Each item represents a price attached to a subscription, useful for subscriptions with multiple pricing tiers or add-ons.
/v1/subscription-items/{id}Retrieve a subscription item
Fetch details for a specific subscription item by ID. Returns the item's price, quantity, and the parent subscription it belongs to.
/v1/subscription-items/{id}/current-usageRetrieve current usage for a subscription item
Fetch the current billing period's usage total for a metered subscription item. Only works with usage-based billing. Use this to display a customer's consumption before the next invoice.
/v1/subscription-items/{id}Update a subscription item
Change the quantity of a subscription item. Only applicable to subscriptions using quantity-based billing. Use this to scale a customer's seat count or usage tier.
Subscriptions
4 operations/v1/subscriptions/{id}Cancel a subscription
Cancel a subscription immediately or at period end
/v1/subscriptionsList all subscriptions
List all subscriptions with status filters
/v1/subscriptions/{id}Retrieve a subscription
Fetch details for a specific subscription by ID. Returns the subscription's status, current billing period, plan details, and renewal date.
/v1/subscriptions/{id}Update a subscription
Update a subscription's plan, status, or billing details
Usage Records
3 operations/v1/usage-recordsCreate a usage record
Report usage for a metered subscription item
/v1/usage-recordsList all usage records
Retrieve a paginated list of usage records for metered billing. Use this to audit reported usage, troubleshoot billing discrepancies, or build usage dashboards for customers.
/v1/usage-records/{id}Retrieve a usage record
Fetch details for a specific usage record by ID. Returns the quantity reported, the subscription item it applies to, and when the usage was recorded.
Users
1 operation/v1/users/meRetrieve the authenticated user
Fetch the profile of the user who owns the current API key. Returns the user's name, email, and avatar URL. Use this to verify API key ownership or display account information.
Variants
2 operations/v1/variantsList all variants
Retrieve a paginated list of product variants. Variants represent different versions of a product, such as pricing tiers, feature sets, or license types.
/v1/variants/{id}Retrieve a variant
Fetch details for a specific product variant by ID. Returns the variant's name, price, description, and associated product information.
Webhooks
5 operations/v1/webhooksCreate a webhook
Register a new webhook endpoint to receive event notifications. Specify the URL to receive events and which event types to subscribe to, such as order or subscription changes.
/v1/webhooks/{id}Delete a webhook
Remove a webhook endpoint so it no longer receives event notifications. Use this to clean up unused endpoints or when decommissioning an integration.
/v1/webhooksList all webhooks
Retrieve a paginated list of webhook endpoints configured for your store. Use this to audit your event subscriptions or verify that all critical events are being captured.
/v1/webhooks/{id}Retrieve a webhook
Fetch details for a specific webhook by ID. Returns the endpoint URL, subscribed event types, and the signing secret used for verification.
/v1/webhooks/{id}Update a webhook
Modify a webhook's endpoint URL, subscribed event types, or signing secret. Use this to change which events trigger notifications or to rotate your webhook secret.