Lemonsqueezy

Lemon Squeezy CLI

lmsq is a CLI for the Lemon Squeezy API with 62 operations across 22 resource types.

When to use this skill

Use this when the user asks you to:

• Query or manage Lemon Squeezy resources (orders, subscriptions, customers, products, etc.)
• Check subscription statuses, order details, or license key states
• Create checkouts, discounts, or webhooks
• Activate, validate, or deactivate license keys
• Refund orders or subscription invoices
• Generate invoices

Prerequisites

Install the CLI if not already available:

npm install -g lmsq

Or run without installing: npx lmsq <command>

Authentication

Set the API key via environment variable (preferred for agents):

export LEMONSQUEEZY_API_KEY=lsq_live_xxxxxxxxxxxx

Or authenticate persistently:

lmsq auth login --key lsq_live_xxxxxxxxxxxx

Resolution order: --api-key flag > LEMONSQUEEZY_API_KEY env var > ~/.config/lemonsqueezy-cli/config.json

Exception: lmsq licenses activate/validate/deactivate uses the public License API and requires no authentication.

Output for agents

When called from a non-TTY shell (which is how agents call it), output is automatically token-efficient flat key: value text with no colors or decoration.

Always minimize token usage by choosing the right output mode:

Do not use --json-raw unless the user specifically asks for the raw JSON:API response. It costs ~2,000 tokens per resource.

Command patterns

All resources follow consistent patterns:

lmsq <resource> list [--store-id <id>] [--filters] [-p <page>] [-s <size>]
lmsq <resource> get <id>
lmsq <resource> create [--required-options] [--optional-options]
lmsq <resource> update <id> [--options]
lmsq <resource> delete <id>

Common flags on every command

List command flags

Get command flags

Examples

# Check how many active subscriptions exist
lmsq subscriptions list --status active --count

# Get a customer's email
lmsq customers get 456 --pluck email

# List recent orders with key fields
lmsq orders list --page-size 10 --fields status,total,user_email

# Get all active subscription IDs
lmsq subscriptions list --status active --only-ids --page-size 100

# Check a subscription's status
lmsq subscriptions get 789 --pluck status

# Create a checkout link
lmsq checkouts create --store-id 1 --variant-id 1

# Refund an order
lmsq orders refund 12345

# Pause a subscription
lmsq subscriptions update 789 --pause void

# Resume a paused subscription
lmsq subscriptions update 789 --unpause

# Activate a license key (no auth needed)
lmsq licenses activate --key XXXXX-XXXXX-XXXXX --instance-name "server-1"

# Validate a license key (no auth needed)
lmsq licenses validate --key XXXXX-XXXXX-XXXXX

Available resources

See references/COMMANDS.md for the full command reference with all resources, subcommands, and their options.

Quick overview:

Lemon Squeezy documentation

If you need to understand platform behavior beyond what the CLI covers:

• Help docs — how Lemon Squeezy works (billing, subscriptions, license keys, etc.)
• API reference — full API documentation with field descriptions and response schemas
• Guides — tutorials and integration walkthroughs

Tips

• Use lmsq <command> --help to see all options for any command.
• Most list commands support --store-id to filter by store.
• List commands support --include <resources> for related data (e.g. --include customer,order-items).
• For subscriptions: --cancelled (via update) cancels at end of billing period; cancel cancels immediately.
• Pause modes: --pause void (loses access) vs --pause free (keeps access).
• License key special values: --activation-limit unlimited, --expires-at never.
• Discount amount types: --amount-type percent (e.g. 20 = 20% off) vs --amount-type fixed (e.g. 500 = $5.00 off).

Converted and distributed by TomeVault — claim your Tome and manage your conversions.