Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Connect Lemon Squeezy to your Atako agents — 15 read and 4 write actions.
| Action | Description |
|---|---|
get_current_user | Retrieve the user the API key belongs to (probe — no argument, works with any key). |
get_customer | Retrieve a single customer by ID. |
get_order | Retrieve a single order by ID. |
get_product | Retrieve a single product by ID. |
get_store | Retrieve a single store by ID. |
get_subscription | Retrieve a single subscription by ID. |
list_customers | List customers, optionally filtered by store or exact email address. |
list_discounts | List discount codes, optionally restricted to one store. |
list_license_keys | List license keys, optionally filtered by store, order, order item, product or status. |
list_orders | List orders, optionally filtered by store, buyer email or order number. |
list_products | List products, optionally restricted to one store. |
list_stores | List the stores in the account. Use it to discover the store_id other actions need. |
list_subscription_invoices | List subscription invoices (renewal payments), optionally filtered by store, subscription, status or refunded flag. |
list_subscriptions | List subscriptions, optionally filtered by store, product, variant, order, subscriber email or status. |
list_variants | List variants (the sellable options of a product), optionally filtered by product or status. Use it to discover the variant_id a checkout needs. |
| Action | Description |
|---|---|
cancel_subscription | Cancel a subscription. Argument: subscription_id (string). The subscription moves to “cancelled” and stops renewing; use update_subscription with resume true to reactivate it before it expires. |
create_checkout | Create a checkout and get back its payment URL (data.attributes.url). Arguments: store_id (string, from list_stores), variant_id (string, from list_variants), custom_price (integer, amount in cents, overrides the variant price), email (string), name (string), discount_code (string), custom (object of free-form key/value pairs echoed back on the resulting order), product_name (string, overrides the product name on the checkout page), product_description (string), redirect_url (string, https URL the buyer lands on after paying), expires_at (ISO 8601 datetime, e.g. 2026-10-30T15:20:06Z), test_mode (boolean). |
create_discount | Create a discount code. Arguments: store_id (string, from list_stores), name (string, internal label), code (string, 3 to 256 characters, uppercase letters and digits only), amount (integer — cents when amount_type is “fixed”, percentage points when it is “percent”), amount_type (“percent” or “fixed”), duration (“once”, “repeating” or “forever”, default “once”), duration_in_months (integer, only with duration “repeating”), is_limited_to_products (boolean — requires variant_ids), variant_ids (array of strings, the variants the code applies to), is_limited_redemptions (boolean), max_redemptions (integer, only with is_limited_redemptions true), starts_at and expires_at (ISO 8601 datetimes), test_mode (boolean). |
update_subscription | Update a subscription: pause it, resume it, change its plan or its billing date. Arguments: subscription_id (string), pause_mode (“void” = no access during the pause, “free” = access kept) to pause, pause_resumes_at (ISO 8601 datetime, optional, with pause_mode), resume (boolean true) to end a pause or reactivate a subscription cancelled but not yet expired, cancelled (boolean true) to cancel at the end of the current period, variant_id (integer, bare number not a string — switches the plan), billing_anchor (integer 1 to 31, day of the month to bill on; 0 resets it to today), trial_ends_at (ISO 8601 datetime), invoice_immediately (boolean, charge a plan change straight away), disable_prorations (boolean). Pass exactly one intent per call. |
