Reference

license_key_created

Fires when a new license key is generated

order_created

Fires when a customer completes a purchase

order_refunded

Fires when a refund is processed for an order

subscription_cancelled

Fires when a subscription is cancelled

subscription_created

Fires when a new subscription is established

subscription_payment_success

Fires when a subscription renewal payment succeeds

affiliate_activated

Fires when an affiliate's application is approved

customer_updated

Fires when a customer's profile information is changed

license_key_updated

Fires when a license key's properties are modified

subscription_expired

Fires when a subscription reaches its final end date

subscription_paused

Fires when billing for a subscription is paused

subscription_payment_failed

Fires when a subscription renewal payment fails

subscription_payment_recovered

Fires when a previously failed payment is successfully collected

subscription_payment_refunded

Fires when a refund is issued for a subscription payment

subscription_resumed

Fires when a cancelled subscription is reactivated

subscription_unpaused

Fires when a paused subscription resumes billing

subscription_updated

Fires when any subscription property changes

List all affiliates

Retrieve a complete list of all affiliates in your program, allowing you to monitor partner activity and manage your affiliate relationships at a glance.

Retrieve an affiliate

Get detailed information about a specific affiliate including their current status, total earnings, and which store they're promoting.

Create a checkout

Creates a custom checkout URL for a product variant, allowing you to pre-fill customer information, apply discount codes, and attach metadata for tracking sales sources.

List all checkouts

Retrieve all checkout sessions created in your Lemon Squeezy store, including their status and details. Use this to monitor purchase activity, track customer checkout behavior, and verify completed transactions.

Retrieve a checkout

Retrieve detailed information about a specific checkout session, including its status, associated products, and any custom data you attached during creation.

Create a customer

Create a new customer record in your store to set up customer profiles before purchases or migrate customer data from other platforms.

List all customers

Retrieve a list of all your customers across your stores with pagination support, enabling you to sync customer data, analyze customer behavior, and maintain accurate records.

Retrieve a customer

Fetch detailed information about a specific customer including their name, email, purchase history, and subscription status. Use this to view customer profiles, verify their details, or check their transaction records.

Update a customer

Update customer information like name, email, or status to keep your customer records current and accurate in Lemon Squeezy.

List all discount redemptions

Retrieve a list of all times customers have redeemed your discount codes, showing which codes are being used and how often. This helps you understand which promotions are driving conversions and engaging your customers.

Retrieve a discount redemption

Look up the details of a specific discount redemption to see which customer used which discount code and which order it was applied to.

Create a discount

Create promotional discount codes with flexible pricing strategies (fixed amount or percentage off) and set rules for which products they apply to and how often they can be used. This lets you run targeted promotions and control when discounts expire.

Delete a discount

Remove a discount code from your store when it's no longer needed, without affecting orders that already used it.

List all discounts

Retrieve all discount codes you've created to review active promotions, check how many times each code has been used, and analyze your discount strategy.

Retrieve a discount

Retrieve detailed information about a specific discount code, including its redemption code, type, discount amount, how many times it's been used, and any restrictions applied.

List all files

Retrieve all files attached to your products in a paginated list. Use this to audit your downloadable assets, check file sizes, and ensure the correct files are linked to each product.

Retrieve a file

Get detailed information about a specific file including its name, size, download URL, and associated product variant. Use this to verify file properties or retrieve download links for customer distribution.

Validate a license key

Verify that a customer's license key is valid, active, and not expired, returning key details like license status and activation limits. Use this to protect your software from unauthorized use and ensure customers have paid for access.

Activate a license key

Register a user's license on their device or environment by creating a new license instance. This enables you to verify and activate purchased licenses within your software application.

Deactivate a license key

Removes an active license key activation to free up a slot, allowing you to reassign it to another device or user when needed.

List all license key instances

Retrieve a list of all devices or environments where your license keys have been activated, helping you track how many installations are currently using each key. This gives you visibility into your product's deployment across your customer base.

Retrieve a license key instance

Retrieves the details of a specific license key activation, including the instance name, associated license key, and activation timestamp. Use this to check the status and properties of individual software activations.

List all license keys

Retrieve all license keys associated with your account in paginated results. Use this to monitor active licenses, track usage against your limits, and manage your licensing inventory.

Retrieve a license key

Get detailed information about a specific license key including its current activation count, expiration date, and status. Use this to verify license validity and monitor usage limits for your customers.

Update a license key

Modify a license key's activation limit, expiration date, or disabled status to manage your customer's access rights. Use this to extend licenses, increase allowed activations, or revoke access when needed.

List all order items

Retrieve a paginated list of individual line items from all orders to analyze product performance and generate detailed sales reports.

Retrieve an order item

Retrieve detailed information about a specific line item from an order, including product details, variant information, pricing, and quantity ordered. This is useful for examining individual items within a customer's purchase.

Issue a refund for an order

Process refunds for customer orders, whether for the full amount or a specific partial amount. Use this when you need to quickly return money to customers due to returns, cancellations, or billing corrections.

Generate an order invoice

Creates a downloadable PDF invoice for a completed order that you can send to customers for their records or accounting purposes.

List all orders

Retrieve a complete list of your orders with pagination support, allowing you to view transaction history and order details across your entire sales platform.

Retrieve an order

Get complete details about a specific order including its status, total amount, customer information, and purchased items to verify transaction details or track customer purchases.

List all prices

Retrieve all your product prices in a paginated format to review pricing tiers, compare costs across product variants, or export pricing data for analysis and reporting.

Retrieve a price

Fetch detailed information about a specific price, including its amount, currency, and billing interval to understand your product's pricing structure.

List all products

Retrieve all products from your Lemon Squeezy store with pagination support, allowing you to access your complete product catalog programmatically.

Retrieve a product

Get detailed information about a specific product including its name, description, pricing, and variants so you can display accurate product details or verify current product setup.

List all stores

Retrieve a complete list of all your Lemon Squeezy stores so you can manage multiple storefronts and identify store IDs for organizing your products and sales data.

Retrieve a store

Get detailed information about a specific store including its name, currency, web address, and revenue performance. Use this to access key store metrics and settings for reporting or configuration purposes.

Generate a subscription invoice PDF

Creates a downloadable PDF invoice for a subscription payment, allowing you to provide customers with professional billing documentation for their recurring charges.

Issue a refund for a subscription invoice

Process refunds for subscription invoice charges, allowing you to refund the full amount or specify a partial refund when needed. This helps you manage customer disputes, billing errors, or service adjustments without manual intervention.

List all subscription invoices

Retrieve all subscription invoices for your customers to track billing history and identify payment issues. This helps you monitor recurring revenue and reconcile your financial records.

Retrieve a subscription invoice

Fetch detailed information about a specific subscription invoice including its status, amount, and associated subscription to track billing records and customer payment history.

List all subscription items

Retrieve all the individual products, services, or pricing tiers attached to your subscriptions, organized by page for easy browsing. This helps you see what customers are paying for across all their active subscriptions.

Retrieve a subscription item

Get detailed information about a specific item within a subscription, including its price, quantity, and which subscription it belongs to. Use this to track what your customers are subscribed to and manage individual subscription components.

Retrieve current usage for a subscription item

Fetches the current billing period's usage total for a metered subscription item to show customers how much they've consumed before the next invoice.

Update a subscription item

Modify the quantity of a subscription item to adjust a customer's billing based on usage or seat count changes. This is essential for scaling services as customer needs evolve.

Cancel a subscription

Immediately stops an active customer subscription and removes their access to your product or service.

List all subscriptions

Retrieve all your active subscriptions and their status from Lemon Squeezy. Use this to monitor your subscriber base, identify at-risk customers, and keep your app's user access in sync with current billing status.

Retrieve a subscription

Retrieve detailed information about a specific customer subscription, including its status, billing period, plan details, and renewal date.

Update a subscription

Modify subscription details including plan changes, pause/resume billing, adjust billing dates, or schedule cancellation at period end. Use this to manage active customer subscriptions and handle plan changes without disrupting service.

Create a usage record

Report metered usage for a subscription to track and bill customers based on actual consumption like API calls, compute hours, or resource usage. This increments the usage total for the current billing period to ensure accurate billing.

List all usage records

Retrieve a paginated list of usage records to monitor and audit how much your customers are consuming from your metered billing services. Use this to verify billing accuracy, investigate customer inquiries about charges, or track usage trends over time.

Retrieve a usage record

Fetch the details of a specific usage record to view the quantity reported, which subscription item it applies to, and when the usage was recorded.

Retrieve the authenticated user

Fetch the profile details of the user who owns the current API key, including name, email, and avatar URL. Use this to verify API access and display account information in your application.

List all variants

Retrieve all product variants from your store, including different pricing tiers, feature sets, and license types. Use this to understand what versions of your products are available and how they're structured.

Retrieve a variant

Get detailed information about a specific product variant, including its price, name, and description. Use this to display accurate product details to customers or manage your inventory across different variants.

Create a webhook

Register a webhook endpoint to automatically receive real-time notifications when specific events occur in your Lemon Squeezy account, such as new orders or subscription changes.

Delete a webhook

Remove a webhook endpoint to stop receiving event notifications from Lemon Squeezy. Use this when you no longer need updates about sales, subscriptions, or other events sent to a specific URL.

List all webhooks

Retrieve all webhook endpoints you've set up to receive real-time notifications from your store. Use this to verify your event subscriptions are configured correctly and audit which business events you're monitoring.

Retrieve a webhook

Retrieve the configuration details for a specific webhook, including its endpoint URL, subscribed events, and signing secret for message verification.

Update a webhook

Modify your webhook configuration to change which events trigger notifications, update the endpoint URL where you receive notifications, or rotate your webhook secret for security purposes.