Skip to main content
Lemon Squeezy logo

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

FieldDescriptionRequiredFormat
Lemon Squeezy API KeyYour Lemon Squeezy API key for authenticationYeseyJ...

Available Actions

Parameters

page
integer
Page number for pagination (Default: 1)
per_page
integer
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": "ListCustomersOutput",
  "type": "object"
}

Parameters

customer_id
string
required
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"
}

Parameters

page
integer
Page number for pagination (Default: 1)
per_page
integer
Number of results per page (max 100) (Default: 10)
store_id
string
Filter orders by store ID
user_email
string
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"
}

Parameters

order_id
string
required
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"
}

Parameters

page
integer
Page number for pagination (Default: 1)
per_page
integer
Number of results per page (max 100) (Default: 10)
store_id
string
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"
}

Parameters

product_id
string
required
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"
}

Parameters

page
integer
Page number for pagination (Default: 1)
per_page
integer
Number of results per page (max 100) (Default: 10)
store_id
string
Filter subscriptions by store ID
status
string
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"
}

Parameters

subscription_id
string
required
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"
}

Parameters

page
integer
Page number for pagination (Default: 1)
per_page
integer
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"
}

Parameters

store_id
string
required
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.

RevenueCat

Stripe

Coinbase