Overview
Add Lemon Squeezy to any ModuleX agent or workflow. Read-only access to the Lemon Squeezy v1 REST API (api.lemonsqueezy.com/v1): customers, orders, products, subscriptions, and stores.
Categories : Finance & Payments · Business Services · Payments · Subscriptions · Digital Products · Auth : API Key · Actions : 10
Authentication
API Key Authentication
Authenticate using your Lemon Squeezy API key
Required Credentials
Field Description Required Format Lemon Squeezy API Key Your Lemon Squeezy API key for authentication Yes eyJ...
Available Actions
list_customers — List all customers from your Lemon Squeezy account with pagination support
retrieve_customer — Retrieve a specific customer by ID with their details and purchase history
Parameters The ID of the customer to retrieve
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "RetrieveCustomerOutput" ,
"type" : "object"
}
list_orders — List all orders from your Lemon Squeezy account with optional filtering
Parameters Page number for pagination (Default: 1)
Number of results per page (max 100) (Default: 10)
Filter orders by store ID
Filter orders by user email
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "ListOrdersOutput" ,
"type" : "object"
}
retrieve_order — Retrieve a specific order by ID with full order details
Parameters The ID of the order to retrieve
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "RetrieveOrderOutput" ,
"type" : "object"
}
list_products — List all products from your Lemon Squeezy account
Parameters Page number for pagination (Default: 1)
Number of results per page (max 100) (Default: 10)
Filter products by store ID
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "ListProductsOutput" ,
"type" : "object"
}
retrieve_product — Retrieve a specific product by ID with full product details
Parameters The ID of the product to retrieve
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "RetrieveProductOutput" ,
"type" : "object"
}
list_subscriptions — List all subscriptions from your Lemon Squeezy account with optional filtering
Parameters Page number for pagination (Default: 1)
Number of results per page (max 100) (Default: 10)
Filter subscriptions by store ID
Filter by subscription status: on_trial, active, paused, past_due, unpaid, cancelled, expired
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "ListSubscriptionsOutput" ,
"type" : "object"
}
retrieve_subscription — Retrieve a specific subscription by ID with full subscription details
Parameters The ID of the subscription to retrieve
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "RetrieveSubscriptionOutput" ,
"type" : "object"
}
list_stores — List all stores from your Lemon Squeezy account
Parameters Page number for pagination (Default: 1)
Number of results per page (max 100) (Default: 10)
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "ListStoresOutput" ,
"type" : "object"
}
retrieve_store — Retrieve a specific store by ID with full store details
Parameters The ID of the store to retrieve
Response {
"additionalProperties" : false ,
"properties" : {
"success" : {
"title" : "Success" ,
"type" : "boolean"
},
"error" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Error"
},
"data" : {
"default" : null ,
"title" : "Data"
},
"meta" : {
"anyOf" : [
{
"additionalProperties" : true ,
"type" : "object"
},
{
"type" : "null"
}
],
"default" : null ,
"title" : "Meta"
}
},
"required" : [
"success"
],
"title" : "RetrieveStoreOutput" ,
"type" : "object"
}
Limits & Quotas
Pagination via JSON:API page[number] / page[size]; per_page is
clamped to 100.
List endpoints return both data (array of resources) and meta
(pagination block); retrievals return just data.
404 retrievals return success=False with a “not found” message;
other non-200 responses surface the body verbatim.
Links