> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Lemon Squeezy

The Lemon Squeezy connector lets your AI agent act in each user's Lemon Squeezy account. Each user connects their own Lemon Squeezy access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 28 tools.

**Authentication:** Bearer Token
**Categories:** Accounting & Finance, CRM & Sales
**Tools:** 28: 20 read, 6 write, 2 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=LEMONSQUEEZY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Lemon Squeezy connection

   In **AgentKit > Connections**, create a Lemon Squeezy connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'lemonsqueezy'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Lemon Squeezy:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'lemonsqueezy_checkouts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "lemonsqueezy"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Lemon Squeezy:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="lemonsqueezy_checkouts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Lemon Squeezy credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'lemonsqueezy_checkout_get',
  toolInput: {
    checkout_id: '<checkout_id>',
  },
  connector: 'lemonsqueezy',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="lemonsqueezy_checkout_get",
    tool_input={
        "checkout_id": "<checkout_id>",
    },
    connection_name="lemonsqueezy",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `lemonsqueezy_checkout_get`

Get Checkout · Read-only

Get one checkout by its ID.
Returns the checkout's store and variant, custom price, product options, checkout options, prefilled data, expires_at and checkout URL.
Use it for one known checkout. Use lemonsqueezy_checkouts_list to browse checkouts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `checkout_id` (`string`, required): The ID of the checkout (a UUID). Use lemonsqueezy_checkouts_list to find IDs. Example: ac470bd4-7c41-474d-b6cd-0f296f5be02a.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, variant. Example: variant.

Example input: `{"checkout_id":"<checkout_id>"}`

### `lemonsqueezy_checkouts_list`

List Checkouts · Read-only

List checkouts created through the API, optionally filtered by store or variant, one page at a time.
Returns each checkout's id, store_id, variant_id, custom price, product, checkout and prefill options, expires_at and checkout URL.
Use it to find checkout links you created. Use lemonsqueezy_checkout_get when you have the checkout ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `store_id` (`string`, optional): Only return checkouts of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.
- `variant_id` (`string`, optional): Only return checkouts for the variant with this ID, from lemonsqueezy_variants_list. Example: 67890.

Example input: `{}`

### `lemonsqueezy_customer_get`

Get Customer · Read-only

Get one customer by its ID.
Returns the customer's name, email, marketing status, city, region, country, total revenue, MRR and customer portal URL.
Use it for one known customer. Use lemonsqueezy_customers_list to find a customer by email.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): The ID of the customer. Use lemonsqueezy_customers_list to find IDs. Example: 112233.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, affiliates, orders, subscriptions, license-keys. Example: orders,subscriptions.

Example input: `{"customer_id":"<customer_id>"}`

### `lemonsqueezy_customers_list`

List Customers · Read-only

List customers, optionally filtered by store or exact email, one page at a time.
Returns each customer's id, store_id, name, email, marketing status, location, total revenue, MRR and customer portal URL.
Use it to browse customers or find one by email. Use lemonsqueezy_customer_get when you have the customer ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, optional): Only return customers with exactly this email address. Example: jane@example.com.
- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `store_id` (`string`, optional): Only return customers of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.

Example input: `{}`

### `lemonsqueezy_discount_get`

Get Discount · Read-only

Get one discount by its ID.
Returns the discount's name, code, amount, amount_type, product limits, redemption limits, duration, start and expiry dates and status.
Use it for one known discount; add include=discount-redemptions to see who used it. Use lemonsqueezy_discounts_list to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): The ID of the discount. Use lemonsqueezy_discounts_list to find IDs. Example: 556677.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, variants, discount-redemptions. Example: discount-redemptions.

Example input: `{"discount_id":"<discount_id>"}`

### `lemonsqueezy_discounts_list`

List Discounts · Read-only

List discount codes, optionally only those in one store, one page at a time.
Returns each discount's id, store_id, name, code, amount, amount_type, redemption limits, duration, starts_at, expires_at and status.
Use it to browse discount codes. Use lemonsqueezy_discount_get when you have the discount ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `store_id` (`string`, optional): Only return discounts of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.

Example input: `{}`

### `lemonsqueezy_license_key_get`

Get License Key · Read-only

Get one license key by its ID.
Returns the key, its customer, order and product IDs, activation limit, instances used, status, disabled flag and expires_at.
Use it for one known license key; add include=license-key-instances to see where it is activated. Use lemonsqueezy_license_keys_list to search keys.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `license_key_id` (`string`, required): The ID of the license key (the numeric object ID, not the key string). Use lemonsqueezy_license_keys_list to find IDs. Example: 334455.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, customer, order, order-item, product, license-key-instances. Example: license-key-instances.

Example input: `{"license_key_id":"<license_key_id>"}`

### `lemonsqueezy_license_keys_list`

List License Keys · Read-only

List license keys, filtered by store, order, order item, product or status, one page at a time.
Returns each key's id, customer, order and product IDs, a short key preview, activation limit and usage, status and expires_at.
Use it to find the keys a customer bought. Use lemonsqueezy_license_key_get when you have the license key ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`string`, optional): Only return license keys from the order with this ID, from lemonsqueezy_orders_list. Example: 998877.
- `order_item_id` (`string`, optional): Only return license keys from the order item with this ID. Example: 445566.
- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `product_id` (`string`, optional): Only return license keys for the product with this ID, from lemonsqueezy_products_list. Example: 54321.
- `status` (`string`, optional): Only return license keys with this status. Allowed values: inactive, active, expired, disabled. Example: active. One of: `inactive`, `active`, `expired`, `disabled`.
- `store_id` (`string`, optional): Only return license keys of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.

Example input: `{}`

### `lemonsqueezy_order_get`

Get Order · Read-only

Get one order by its ID.
Returns the order's number, buyer, currency, amounts in cents and USD, tax, discount, status, refund details, first order item and receipt URL.
Use it for one known order; add include=order-items or license-keys to get them in the same call. Use lemonsqueezy_orders_list to search orders.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`string`, required): The ID of the order. Use lemonsqueezy_orders_list to find IDs. Example: 998877.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, customer, affiliate, order-items, subscriptions, license-keys, discount-redemptions. Example: order-items.

Example input: `{"order_id":"<order_id>"}`

### `lemonsqueezy_orders_list`

List Orders · Read-only

List orders, newest first, optionally filtered by store, buyer email or order number, one page at a time.
Returns each order's id, order_number, customer_id, buyer name and email, currency, subtotal, tax, total, status, refund state and first order item.
Use it to browse sales or find a buyer's orders. Use lemonsqueezy_order_get when you have the order ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_number` (`string`, optional): Only return the order with this order number (the number shown to the buyer, not the order ID). Example: 1001.
- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `store_id` (`string`, optional): Only return orders of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.
- `user_email` (`string`, optional): Only return orders whose buyer email is exactly this address. Example: jane@example.com.

Example input: `{}`

### `lemonsqueezy_product_get`

Get Product · Read-only

Get one Lemon Squeezy product by its ID.
Returns the product's name, slug, description, status, price, price range, buy_now_url, thumbnail and test_mode flag.
Use it for one known product; add include=variants to get its variants in the same call. Use lemonsqueezy_products_list to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`string`, required): The ID of the product. Use lemonsqueezy_products_list to find IDs. Example: 54321.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, variants. Example: variants.

Example input: `{"product_id":"<product_id>"}`

### `lemonsqueezy_products_list`

List Products · Read-only

List products, optionally only those in one store, one page at a time.
Returns each product's id, store_id, name, slug, description, status, price, price range, buy_now_url and thumbnail.
Use it to browse a catalogue. Use lemonsqueezy_product_get for one product, and lemonsqueezy_variants_list for its variants.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `store_id` (`string`, optional): Only return products in the store with this ID, from lemonsqueezy_stores_list. Example: 12345.

Example input: `{}`

### `lemonsqueezy_store_get`

Get Store · Read-only

Get one Lemon Squeezy store by its ID.
Returns the store's name, slug, domain, URL, currency, country, plan, sales count and revenue totals (all time and last 30 days).
Use it for one known store. Use lemonsqueezy_stores_list to browse stores.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `store_id` (`string`, required): The ID of the store. Use lemonsqueezy_stores_list to find IDs. Example: 12345.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: products, orders, subscriptions, discounts, license-keys, webhooks. Example: products.

Example input: `{"store_id":"<store_id>"}`

### `lemonsqueezy_stores_list`

List Stores · Read-only

List the stores the connected Lemon Squeezy account can access, one page at a time.
Returns each store's id, name, slug, domain, URL, currency, plan, total sales and revenue figures, plus pagination meta.
Use it to find a store_id for other tools. Use lemonsqueezy_store_get for one store you already know.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.

Example input: `{}`

### `lemonsqueezy_subscription_get`

Get Subscription · Read-only

Get one subscription by its ID.
Returns the subscription's customer, product, variant, status, pause and cancel state, trial end, billing anchor, card details, renews_at, ends_at and update-payment and customer portal URLs.
Use it for one known subscription. Use lemonsqueezy_subscriptions_list to find subscriptions by customer email or status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subscription_id` (`string`, required): The ID of the subscription. Use lemonsqueezy_subscriptions_list to find IDs. Example: 223344.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices. Example: subscription-invoices.

Example input: `{"subscription_id":"<subscription_id>"}`

### `lemonsqueezy_subscription_invoices_list`

List Subscription Invoices · Read-only

List subscription invoices, filtered by store, subscription, status or refund state, one page at a time.
Returns each invoice's id, subscription_id, customer_id, billing reason, card details, currency, subtotal, discount, tax, total, status, refund state and invoice URL.
Use it to review a subscription's billing history or find unpaid renewals. Use lemonsqueezy_orders_list for one-time purchases.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `refunded` (`boolean`, optional): Set to true for only fully refunded invoices, or false for only invoices that are not. Example: true.
- `status` (`string`, optional): Only return invoices with this status. Allowed values: pending, paid, void, refunded, partial_refund. Example: paid. One of: `pending`, `paid`, `void`, `refunded`, `partial_refund`.
- `store_id` (`string`, optional): Only return invoices of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.
- `subscription_id` (`string`, optional): Only return invoices of the subscription with this ID, from lemonsqueezy_subscriptions_list. Example: 223344.

Example input: `{}`

### `lemonsqueezy_subscriptions_list`

List Subscriptions · Read-only

List subscriptions, newest first, filtered by store, order, product, variant, buyer email or status, one page at a time.
Returns each subscription's id, customer_id, product and variant, buyer name and email, status, pause and cancel state, renews_at, ends_at and portal URLs.
Use it to browse or find subscriptions. Use lemonsqueezy_subscription_get when you have the subscription ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`string`, optional): Only return subscriptions created by the order with this ID, from lemonsqueezy_orders_list. Example: 998877.
- `order_item_id` (`string`, optional): Only return subscriptions of the order item with this ID. Example: 445566.
- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `product_id` (`string`, optional): Only return subscriptions to the product with this ID, from lemonsqueezy_products_list. Example: 54321.
- `status` (`string`, optional): Only return subscriptions with this status. Allowed values: on_trial, active, paused, past_due, unpaid, cancelled, expired. Example: active. One of: `on_trial`, `active`, `paused`, `past_due`, `unpaid`, `cancelled`, `expired`.
- `store_id` (`string`, optional): Only return subscriptions of the store with this ID, from lemonsqueezy_stores_list. Example: 12345.
- `user_email` (`string`, optional): Only return subscriptions whose buyer email is exactly this address. Example: jane@example.com.
- `variant_id` (`string`, optional): Only return subscriptions to the variant with this ID, from lemonsqueezy_variants_list. Example: 67890.

Example input: `{}`

### `lemonsqueezy_user_get`

Get Authenticated User · Read-only

Get the Lemon Squeezy user that owns the connected API key.
Returns the user id, name, email, color and avatar URL.
Use it to check which account the connection uses. Use lemonsqueezy_stores_list to see that account's stores.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `lemonsqueezy_variant_get`

Get Variant · Read-only

Get one product variant by its ID.
Returns the variant's name, price, subscription interval, trial settings, pay-what-you-want settings, license key settings and status.
Use it for one known variant. Use lemonsqueezy_variants_list to browse a product's variants.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `variant_id` (`string`, required): The ID of the variant. Use lemonsqueezy_variants_list to find IDs. Example: 67890.
- `include` (`string`, optional): Comma-separated related resources to return in the response's included array, so you need fewer calls. Allowed values: product, files, price-model. Example: product.

Example input: `{"variant_id":"<variant_id>"}`

### `lemonsqueezy_variants_list`

List Variants · Read-only

List product variants, optionally filtered by product or status, one page at a time.
Returns each variant's id, product_id, name, price, billing interval, trial settings, license key settings and status.
Use it to find the variant_id needed for checkouts and subscription plan changes. Use lemonsqueezy_variant_get for one variant.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page of results to return, starting at 1. Read meta.page.lastPage in the response to see how many pages exist. Example: 2.
- `page_size` (`integer`, optional): Number of results per page, from 1 to 100. Lemon Squeezy returns 10 when this is left empty. Example: 50.
- `product_id` (`string`, optional): Only return variants of the product with this ID, from lemonsqueezy_products_list. Example: 54321.
- `status` (`string`, optional): Only return variants with this status. A pending variant is the default variant of a product that has no other variants. Allowed values: pending, draft, published. Example: published. One of: `pending`, `draft`, `published`.

Example input: `{}`

### `lemonsqueezy_checkout_create`

Create Checkout · Write

Create a unique checkout link for a product variant, with optional custom price, prefilled buyer details, discount code, custom data and expiry.
Returns the checkout's id and its url to send to the buyer, plus the options it was created with.
Use it to send a buyer a personal payment link. Use lemonsqueezy_checkout_get to read a checkout you created.
Run lemonsqueezy_stores_list and lemonsqueezy_variants_list first to get the store_id and variant_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `store_id` (`string`, required): The ID of the store the checkout belongs to. Use lemonsqueezy_stores_list to find IDs. Example: 12345.
- `variant_id` (`string`, required): The ID of the variant being sold. Use lemonsqueezy_variants_list to find IDs. Example: 67890.
- `billing_country` (`string`, optional): Billing country to prefill, as a two-letter ISO 3166-1 code. Example: US.
- `billing_zip` (`string`, optional): Billing zip or postal code to prefill. Example: 10001.
- `checkout_options` (`object`, optional): Display options for the checkout page: embed (overlay), whether to show media, logo, description and the discount field, skip_trial, subscription_preview, hex colors such as button_color, and locale (for example en or fr). Example: {"button_color": "#7047EB", "locale": "en"}.
- `custom_data` (`object`, optional): Your own key-value data to attach to the checkout; it is passed on to the resulting order, subscription and webhooks. Example: {"user_id": "123"}.
- `custom_price` (`integer`, optional): Custom price in cents that replaces the variant's price; for subscriptions it is used for all renewals. Example: 4900.
- `discount_code` (`string`, optional): Discount code to prefill, from lemonsqueezy_discounts_list. Example: BF2026.
- `email` (`string`, optional): Email address to prefill at checkout. Example: jane@example.com.
- `expires_at` (`string`, optional): When the checkout link expires, as an ISO 8601 date-time. Leave empty for a link that never expires. Example: 2026-12-31T23:59:59Z.
- `name` (`string`, optional): Buyer name to prefill at checkout. Example: Jane Doe.
- `preview` (`boolean`, optional): Set to true to return a price preview (subtotal, tax, total) with the checkout. Example: true.
- `product_options` (`object`, optional): Overrides for the product shown at this checkout: name, description, media (image URLs), redirect_url after purchase, receipt button text, link and thank-you note, and enabled_variants (variant IDs to show). Example: {"redirect_url": "https://example.com/thanks", "enabled_variants": [67890]}.
- `tax_number` (`string`, optional): Tax or VAT number to prefill. Example: GB123456789.
- `test_mode` (`boolean`, optional): Set to true to create the checkout in test mode. Example: false.
- `variant_quantities` (`array`, optional): Quantities per variant for the checkout. Each item has a numeric variant_id and a quantity. Example: [{"variant_id": 67890, "quantity": 3}].

Example input: `{"store_id":"<store_id>","variant_id":"<variant_id>"}`

### `lemonsqueezy_customer_create`

Create Customer · Write

Create a customer in a Lemon Squeezy store.
Returns the new customer's id, name, email, status and location.
Use it to add a customer before they buy. Use lemonsqueezy_customer_update to change an existing customer.
Run lemonsqueezy_stores_list first to get the store_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address of the customer. Example: jane@example.com.
- `name` (`string`, required): Full name of the customer. Example: Jane Doe.
- `store_id` (`string`, required): The ID of the store the customer belongs to. Use lemonsqueezy_stores_list to find IDs. Example: 12345.
- `city` (`string`, optional): City of the customer. Example: New York.
- `country` (`string`, optional): Two-letter ISO 3166-1 country code of the customer. Example: US.
- `region` (`string`, optional): Region, state or province of the customer. Example: NY.

Example input: `{"email":"<email>","name":"<name>","store_id":"<store_id>"}`

### `lemonsqueezy_customer_update`

Update Customer · Write

Update a customer's name, email, location or archive their marketing status. Only the fields you provide change.
Returns the updated customer object.
Use it to edit an existing customer. Use lemonsqueezy_customer_create to add a new one.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): The ID of the customer. Use lemonsqueezy_customers_list to find IDs. Example: 112233.
- `city` (`string`, optional): New city of the customer. Example: Boston.
- `country` (`string`, optional): New two-letter ISO 3166-1 country code of the customer. Example: GB.
- `email` (`string`, optional): New email address of the customer. Example: jane.smith@example.com.
- `name` (`string`, optional): New full name of the customer. Example: Jane Smith.
- `region` (`string`, optional): New region, state or province of the customer. Example: MA.
- `status` (`string`, optional): Set to archived to archive the customer so they no longer receive marketing emails. Allowed value: archived. Example: archived. One of: `archived`.

Example input: `{"customer_id":"<customer_id>"}`

### `lemonsqueezy_discount_create`

Create Discount · Write

Create a percentage or fixed-amount discount code in a store, optionally limited to some variants, a number of redemptions or a date range.
Returns the new discount's id, code, amount, status and limits.
Use it to make a new code. Use lemonsqueezy_checkout_create with discount_code to pre-fill a code at checkout.
Run lemonsqueezy_stores_list first to get the store_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): Discount amount: cents when amount_type is fixed (1000 is $10.00), or a percentage when amount_type is percent (20 is 20%). Example: 20.
- `amount_type` (`string`, required): Whether amount is a percent or a fixed amount in cents. Allowed values: percent, fixed. Example: percent. One of: `percent`, `fixed`.
- `code` (`string`, required): Code customers enter at checkout: 3 to 256 uppercase letters and numbers. Example: BF2026.
- `name` (`string`, required): Internal name of the discount. Example: Black Friday 20% off.
- `store_id` (`string`, required): The ID of the store the discount belongs to. Use lemonsqueezy_stores_list to find IDs. Example: 12345.
- `duration` (`string`, optional): For subscriptions, how often the discount applies: once (first payment only), repeating (for duration_in_months), or forever. Defaults to once. Example: repeating. One of: `once`, `repeating`, `forever`.
- `duration_in_months` (`integer`, optional): Number of months a repeating discount applies; for yearly plans use years times 12. Defaults to 1. Example: 3.
- `expires_at` (`string`, optional): When the discount expires, as an ISO 8601 date-time. Leave empty for no expiry. Example: 2026-12-01T00:00:00Z.
- `max_redemptions` (`integer`, optional): Maximum number of times the code can be redeemed in total. Leave empty for unlimited. Example: 100.
- `starts_at` (`string`, optional): When the discount becomes valid, as an ISO 8601 date-time. Leave empty to start now. Example: 2026-11-27T00:00:00Z.
- `test_mode` (`boolean`, optional): Set to true to make the discount apply only to test mode orders. Example: false.
- `variant_ids` (`array`, optional): Variant IDs the discount is limited to, from lemonsqueezy_variants_list. Leave empty to apply it to all products. Example: ["67890", "67891"].

Example input: `{"amount":20,"amount_type":"percent","code":"<code>","name":"<name>","store_id":"<store_id>"}`

### `lemonsqueezy_license_key_update`

Update License Key · Write

Change a license key's activation limit or expiry date, or disable or re-enable it. Only the fields you provide change.
Returns the updated license key object.
Use it to manage an issued key. Use lemonsqueezy_license_key_get to read the key's current settings first.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `license_key_id` (`string`, required): The ID of the license key (the numeric object ID, not the key string). Use lemonsqueezy_license_keys_list to find IDs. Example: 334455.
- `activation_limit` (`integer`, optional): New maximum number of activations for the key. Example: 5.
- `disabled` (`boolean`, optional): Set to true to disable the key, or false to enable it again. Example: true.
- `expires_at` (`string`, optional): New expiry date of the key as an ISO 8601 date-time. Example: 2027-04-20T10:30:00Z.
- `never_expires` (`boolean`, optional): Set to true to make the key perpetual (sends expires_at as null). Do not combine with expires_at. Example: true.
- `unlimited_activations` (`boolean`, optional): Set to true to make activations unlimited (sends activation_limit as null). Do not combine with activation_limit. Example: true.

Example input: `{"license_key_id":"<license_key_id>"}`

### `lemonsqueezy_subscription_update`

Update Subscription · Write

Change a subscription's plan, pause or resume payment collection, resume a cancelled subscription, or change its trial end or billing day. Only the fields you provide change.
Returns the updated subscription object. A plan change is prorated unless you disable prorations, and can charge the customer.
Use it to change an existing subscription. Use lemonsqueezy_subscription_cancel to cancel one.
Subscriptions paid with PayPal are not changed; the response then holds a customer portal URL for the customer to make the change.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscription_id` (`string`, required): The ID of the subscription. Use lemonsqueezy_subscriptions_list to find IDs. Example: 223344.
- `billing_anchor` (`integer`, optional): Day of the month (1 to 31) on which to collect renewal payments; 0 resets it to today and removes an active trial. Example: 1.
- `cancelled` (`boolean`, optional): Set to false to resume a cancelled subscription before its ends_at date, or true to cancel it. Example: false.
- `disable_prorations` (`boolean`, optional): Set to true to skip proration and charge the new price at the next renewal. Overrides invoice_immediately. Defaults to false. Example: true.
- `invoice_immediately` (`boolean`, optional): Set to true to charge a prorated invoice for the change right away instead of at the next renewal. Defaults to false. Example: true.
- `pause_mode` (`string`, optional): Pause payment collection. void voids invoices while you cannot offer the service; free keeps the service running for free. Allowed values: void, free. Example: void. One of: `void`, `free`.
- `pause_resumes_at` (`string`, optional): When a pause ends and payment collection starts again, as an ISO 8601 date-time. Only used with pause_mode. Example: 2026-12-01T00:00:00Z.
- `trial_ends_at` (`string`, optional): When the subscription's free trial should end, as an ISO 8601 date-time. Example: 2026-12-20T10:30:00Z.
- `unpause` (`boolean`, optional): Set to true to unpause a paused subscription (sends pause as null). Do not combine with pause_mode. Example: true.
- `variant_id` (`integer`, optional): ID of the variant to move the subscription to (upgrade or downgrade), from lemonsqueezy_variants_list. Example: 67891.

Example input: `{"subscription_id":"<subscription_id>"}`

### `lemonsqueezy_discount_delete`

Delete Discount · Destructive

Permanently delete a discount code so it can no longer be redeemed.
Returns an empty response on success.
Use it to remove a code. Use lemonsqueezy_discounts_list to find the discount ID first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): The ID of the discount to delete. Use lemonsqueezy_discounts_list to find IDs. Example: 556677.

Example input: `{"discount_id":"<discount_id>"}`

### `lemonsqueezy_subscription_cancel`

Cancel Subscription · Destructive

Cancel an active subscription. It stays valid until its ends_at date (the grace period) and then expires.
Returns the subscription object with status cancelled and the ends_at date.
Use it to stop future renewals. Use lemonsqueezy_subscription_update with cancelled=false to resume it before ends_at.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `subscription_id` (`string`, required): The ID of the subscription to cancel. Use lemonsqueezy_subscriptions_list to find IDs. Example: 223344.

Example input: `{"subscription_id":"<subscription_id>"}`

## Related

Other Accounting & Finance connectors ([all 82](/agentkit/connectors/?category=accounting-finance)):

- [QuickBooks](/agentkit/connectors/quickbooks/): Scalekit connector, OAuth, 117 tools
- [Xero](/agentkit/connectors/xero/): Scalekit connector, OAuth, 94 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
