Skip to main content
Lemon Squeezy logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: LEMON_SQUEEZY
  • Version: 20261101_00

Tools

Slug: LEMON_SQUEEZY_CREATE_CUSTOMERTool to create a new customer. Use after verifying the store exists and you need to add a customer to it. Example: “Create a customer John Doe with email johndoe@example.com in store 1.”

Input Parameters

object
required
The customer resource data object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_CREATE_DISCOUNTTool to create a new discount code in Lemon Squeezy. Use when you need to create promotional discounts for products or subscriptions. Example: “Create a discount code SUMMER20 with 20% off in store 123.”

Input Parameters

object
required
The discount resource data object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_CREATE_WEBHOOKTool to create a new webhook for receiving event notifications. Use when you need to register a webhook endpoint to receive events like order_created, subscription_created, etc. Specify the webhook URL, signing secret, and event types to subscribe to.

Input Parameters

object
required
Main data object for webhook creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_DELETE_DISCOUNTTool to delete a discount by its ID. Use when you need to permanently remove a discount from a store.

Input Parameters

string
required
The ID of the discount to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_DELETE_WEBHOOKTool to delete a webhook. Use when you need to remove a registered webhook endpoint.

Input Parameters

string
required
The ID of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_AFFILIATESTool to list all affiliates. Use when you need to retrieve affiliates with optional filters and pagination.

Input Parameters

string ("createdAt" | "-createdAt")
Sort order: ‘createdAt’ ascending or ‘-createdAt’ descending.
integer
Filter affiliates by the ID of the store they belong to.
integer
Number of affiliates per page (1-100).
string
Filter affiliates by user email.
integer
Page number for pagination, starting at 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_CHECKOUTSRetrieves a page of checkouts, optionally filtered by store or variant. The response includes pagination metadata.

Input Parameters

integer
Only return checkouts belonging to the store with this ID.
integer
Only return checkouts belonging to the variant with this ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_CUSTOMERSRetrieves a paginated list of all customers from your Lemon Squeezy store(s). Returns customer details including email, name, location, revenue metrics (MRR, total revenue), marketing status, and relationships to orders, subscriptions, and license keys. Use this action to: - Get all customers across stores or filter by specific store_id - Find a customer by email address - List customers with pagination support (default 10 per page, max 100) - Access customer portal URLs and relationship links All parameters are optional. Without filters, returns all customers ordered by creation date (newest first).

Input Parameters

string
Filter customers by email address.
integer
Filter customers by the ID of the store to which they belong.
integer
Number of customers per page (1-100).
integer
Page number for pagination (starting at 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_DISCOUNT_REDEMPTIONSTool to list all discount redemptions. Use when you need a paginated list of discount redemptions, optionally filtering by discount or order.

Input Parameters

integer
Return discount redemptions that belong to the order with this ID.
integer
Number of items per page (1-100)
integer
Return discount redemptions that belong to the discount with this ID.
integer
Page number for pagination (starting at 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_DISCOUNTSTool to list all discounts. Use when you need a paginated list of discounts after confirming authentication.

Input Parameters

integer
Filter discounts by store ID. Only return discounts belonging to the specified store.
integer
Number of discounts per page (1-100)
integer
Page number for pagination (starting at 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_FILESRetrieves a paginated list of files from Lemon Squeezy. Use this to get digital goods that can be downloaded by customers after purchase. Each file belongs to a variant and includes download URLs (signed, expiring after 1 hour, rate-limited to 10 downloads/day/IP). Filter by variant ID or control pagination with page number and size.

Input Parameters

string
Comma-separated list of related resources to include (e.g., ‘variant’).
integer
Number of items per page (1-100).
integer
Filter files by variant ID. Only returns files associated with the specified variant.
integer
Page number to retrieve (starting at 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_LICENSE_KEY_INSTANCESTool to list all license key instances. Use when you need a paginated list of license key instances, optionally filtering by license key ID.

Input Parameters

integer
Number of instances per page (1-100).
integer
Page number for pagination (starting at 1).
integer
Filter instances by the ID of the license key they belong to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_LICENSE_KEYSTool to list all license keys. Use when you need a paginated list of license keys, optionally filtering by store, order, order item, or product.

Input Parameters

string
Comma-separated list of related resources to include (e.g., ‘store,customer,order’).
integer
Filter license keys by order ID.
integer
Filter license keys by store ID.
integer
Number of license keys per page (1-100).
integer
Filter license keys by product ID.
integer
Page number for pagination (starting at 1).
integer
Filter license keys by order item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_ORDER_ITEMSTool to list all order items. Use when you need a paginated list of order items, optionally filtered by order, product, or variant. Note: the first_order_item field on an order object returns only one item; use filter_order_id here to retrieve all line items for multi-item orders.

Input Parameters

integer
Number of order items per page (1-100)
integer
Page number for pagination (starting at 1)
string
Filter order items by order ID
string
Filter order items by product ID
string
Filter order items by variant ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_ORDERSTool to list all orders. Use when you need a paginated list of orders, optionally filtering by store or user email. Monetary fields (e.g., subtotal, tax, total) are integers in the smallest currency unit (e.g., cents); use *_formatted variants for display only, not calculations.

Input Parameters

integer
Return only orders belonging to the store with this ID. Omitting this in multi-store setups returns orders across all stores, which can corrupt aggregations.
integer
Number of orders per page (1-100)
string
Return only orders where the user_email field matches this email address.
integer
Page number for pagination (starting at 1) Check meta.page in the response to determine whether additional pages exist.
integer
Return only the order with this specific order number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_PRICESTool to list all prices. Use when you need a paginated list of all prices, optionally filtering by variant.

Input Parameters

integer
Number of prices per page (1-100)
integer
Return only prices associated with the variant with this ID.
integer
Page number for pagination (starting at 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_PRODUCTSList all products from your Lemon Squeezy store with pagination and filtering. Returns a paginated list of products ordered by name. Each product includes pricing, status, thumbnails, checkout URLs, and metadata. Useful for browsing your product catalog, checking product details, or filtering by store.

Input Parameters

integer
Filter products by store ID (optional)
integer
Number of products per page (1-100, default: 10)
integer
Page number to retrieve (default: 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_STORESRetrieves a paginated list of all stores belonging to the authenticated Lemon Squeezy account. This action returns comprehensive store information including store details (name, slug, domain, URL), financial metrics (total sales/revenue, 30-day sales/revenue), configuration (plan, country, currency), and relationship links to associated resources (products, orders, subscriptions, discounts, license keys, webhooks, and affiliates). Returns stores ordered by name in ascending order with pagination metadata. No input parameters required. Use this as a starting point to discover available stores before working with other store-specific resources.

Input Parameters

integer
Number of results per page. Default: 10, max: 100.
integer
Page number to retrieve. Default: 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_SUBSCRIPTION_INVOICESTool to list all subscription invoices. Use when you need a paginated list of subscription invoices with optional filters.

Input Parameters

string
Filter invoices by status
boolean
Filter invoices by refunded state (true/false)
integer
Filter invoices by store ID
integer
Number of items per page (1-100)
integer
Page number for pagination (starting at 1)
integer
Filter invoices by subscription ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_SUBSCRIPTION_ITEMSTool to list all subscription items. Use when you need a paginated list of items across subscriptions for reporting or auditing.

Input Parameters

integer
Filter subscription items by the ID of the price.
integer
Number of items per page (1-100)
integer
Page number for pagination (starting at 1)
integer
Filter subscription items by the ID of the subscription they belong to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_SUBSCRIPTIONSTool to list all subscriptions. Use when you need a paginated list of subscriptions, optionally filtered by store, order, product, or status.

Input Parameters

string
Return only subscriptions with this status (e.g., ‘active’, ‘cancelled’).
integer
Return only subscriptions belonging to the order with this ID.
integer
Return only subscriptions belonging to the store with this ID.
integer
Number of subscriptions per page (1-100).
integer
Return only subscriptions belonging to the product with this ID.
string
Return only subscriptions where the user_email matches this address.
integer
Return only subscriptions belonging to the variant with this ID.
integer
Page number for pagination (starting at 1).
integer
Return only subscriptions belonging to the order item with this ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_USAGE_RECORDSRetrieves all usage records from Lemon Squeezy, with optional filtering and pagination. Usage records track consumption for usage-based billing on subscription items. Each record represents reported usage with a quantity and action type (increment or set). Records are returned in descending order by creation date (newest first). Use this when you need to: - View all usage records across subscription items - Filter usage records for a specific subscription item - Paginate through large sets of usage records Note: Returns an empty list if no usage records exist or the filter matches nothing.

Input Parameters

integer
Number of usage records to return per page. Must be between 1 and 100. Default is 10 if not specified.
integer
The page number to retrieve, starting from 1. Default is 1 if not specified.
integer
Filter to only show usage records belonging to this subscription item ID. Omit to retrieve usage records from all subscription items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_VARIANTSRetrieves a paginated list of product variants from Lemon Squeezy. A variant represents a variation of a product with its own pricing options, files, and license key settings. You can filter by product ID and status (pending/draft/published), and control pagination with page number and size.

Input Parameters

string ("pending" | "draft" | "published")
Return only variants with the given status. One of ‘pending’, ‘draft’, or ‘published’.
integer
Number of items per page (1-100).
integer
Return only variants associated with this product ID.
integer
Page number to return (starting at 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_LIST_ALL_WEBHOOKSTool to list all webhooks. Use when you need to retrieve registered webhooks. Supports optional filtering by store ID and pagination parameters for controlling result size and navigation.

Input Parameters

integer
Only return webhooks belonging to the store with this ID.
integer
Number of webhooks per page (1-100).
integer
Page number to retrieve (starting from 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_RETRIEVE_AUTHENTICATED_USERTool to retrieve the currently authenticated user from Lemon Squeezy. Use when you need to get details about the user associated with the current API key, including their name, email, avatar, and account timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_RETRIEVE_CUSTOMERTool to retrieve a specific customer by their ID. Use when you need detailed information about a single customer including their email, name, location, revenue metrics, and relationships to orders and subscriptions.

Input Parameters

string
required
The ID of the customer to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_RETRIEVE_DISCOUNTTool to retrieve a single discount by ID. Use when you need details about a specific discount.

Input Parameters

string
required
The ID of the discount to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_RETRIEVE_STORETool to retrieve a store by its ID. Use when you need to get detailed information about a specific store. Returns comprehensive store data including financial metrics, configuration, and related resource links.

Input Parameters

string
required
The ID of the store to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_RETRIEVE_WEBHOOKTool to retrieve a webhook by its ID. Use when you need to get details of a specific webhook configuration.

Input Parameters

string
required
The unique identifier of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_UPDATE_CUSTOMERTool to update an existing customer with the given ID. Use when you need to modify customer details like name, email, or address information. At least one attribute field must be provided to update.

Input Parameters

string
required
The ID of the customer to update
string
The city of the customer
string
The full name of the customer
string
The email of the customer
string
The region/state of the customer
string
ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘GB’, ‘DE’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_UPDATE_WEBHOOKTool to update an existing webhook. Use when you need to modify the URL, events, or secret for a registered webhook.

Input Parameters

object
required
Data wrapper for the webhook update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMON_SQUEEZY_VALIDATE_LICENSETool to validate a license key and optionally a specific license key instance. Use when you need to check if a license key is valid and active.

Input Parameters

string
Optionally validate a specific license key instance. If provided, validates the instance; if omitted, validates the license key and returns ‘instance’: null in response.
string
required
The license key to validate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not