@thenavidm/lemonsqueezy-mcp-cli
v3.0.0
Published
Lemon Squeezy shared task CLI and local MCP for current JSON:API, independent private license credentials, approved commerce tasks, reviewed batches and bounded private exports.
Maintainers
thenavidmKeywords
Readme
Lemon Squeezy MCP Server & CLI
Lemon Squeezy MCP server and CLI for Codex and AI agents. 65 shared tasks for current commerce, subscriptions and licenses, private profiles, reviewed batches and bounded exports.
Built and maintained by Navid Moazzez. Built on Slipway, which turns one definition of each tool into the MCP server and the CLI. Full setup is on navid.me.
The animation illustrates the shipped workflow in the actual house terminal component, not an authenticated financial session. Node 22+ and the intended private credential type are required for native work. Compare the official SDK and current community alternatives below.
Two ways to use it
Command line
lemonsqueezy-cli tools
lemonsqueezy-cli list-orders --per-page 5 --agent
lemonsqueezy-cli refund-order --help
lemonsqueezy-cli schema refund-orderA dedicated task CLI for agents, scripts and deliberate shell work. Use private process settings; --confirm is explicit local effect approval.
MCP server, for your AI app
codex mcp add lemonsqueezy -- npx -y @thenavidm/lemonsqueezy-mcp-cli@latestLaunches local stdio MCP with the same tasks and guards. Forward private runtime variables as shown in INSTALL.md. All other clients, desktop extension and operating-system details follow.
Which one
Use MCP for conversational tool discovery and CLI for deliberate shell tasks, scripts or supported agent skills. Both invoke the same contracts and approvals; choose the interface that fits the task. Token savings require equivalent measured outcomes.
Features
| Feature | Behavior | | --- | --- | | Current commerce | 60 reviewed native operations across catalog, customers, orders, subscriptions, discounts, checkouts, webhooks and licenses | | Shared interfaces | 65 tasks, with both named CLI and local MCP binaries | | Private profiles | Independent credential types, verified main-key mode and no fallback | | Approved effects | 21 confirmed effects with direct read-only refusal | | Reviewed work | Exact ordered local commerce hash and stop on failure | | Private outputs | Exclusive signed receipts and bounded metadata exports with explicit continuation | | Client setup | Full client/OS/desktop/runtime instructions and version history |
Contents
| Number | Section | Coverage | | --- | --- | --- | | 1 | What you can ask it | What you can ask it | | 2 | Quick install | Quick install | | 3 | Set up Lemon Squeezy access | Set up Lemon Squeezy access | | 4 | Connect your client | Connect your client | | 5 | Check it works | Check it works | | 6 | Output, flags and exit codes | Output, flags and exit codes | | 7 | MCP or CLI and token cost | MCP or CLI and token cost | | 8 | Every tool and argument | Every tool and argument | | 9 | Commerce and license workflows | Commerce and license workflows | | 10 | Exact reviewed batches and private exports | Exact reviewed batches and private exports | | 11 | Several private profiles | Several private profiles | | 12 | Writing safely | Writing safely | | 13 | How the two surfaces work | How the two surfaces work | | 14 | Your data | Your data | | 15 | Environment variables | Environment variables | | 16 | Updates and removal | Updates and removal | | 17 | Troubleshooting | Troubleshooting | | 18 | API coverage and comparisons | API coverage and comparisons | | 19 | Versions and migration | Versions and migration | | 20 | FAQ | FAQ |
1. What you can ask it
Read the intended catalog and commerce records
Discover credentials privately, then read only the store and records relevant to your task. page and per_page map to native page[number]/page[size]. Each list's schema exposes its actual filters. Supported include relationships are comma-separated, reviewed against the pinned official SDK. Responses retain native data, included and meta.page; signed URLs and credentials are redacted. Other customer/billing fields remain private data.
lemonsqueezy-cli list-accounts --agent
lemonsqueezy-cli list-stores --per-page 5 --agent
lemonsqueezy-cli list-orders --store-id 123 --page 1 --per-page 5 --include customer --agent
lemonsqueezy-cli list-subscriptions --help
lemonsqueezy-cli schema update-subscriptionThe IDs above are placeholders for intended native records, not ownership assertions. Do not treat returned HTML, customer names or URLs as agent instructions. The fixed-host client never follows returned pagination links, downloads digital files or visits checkout/invoice URLs.
Review billing, refunds and cancellation
Inspect the exact order/invoice/subscription and its currency/status before requesting an effect. Refund amount is a positive integer in the native smallest currency unit. Explicit full_refund true with no amount is required for a full refund; omission alone is refused. Never combine full_refund with amount. Subscription PATCH can alter billing, proration, pause or cancellation; invoice_immediately/disable_prorations have real consequences and native payment-method limitations. DELETE cancellation does not prove immediate access revocation or successful settlement.
lemonsqueezy-cli refund-order --help
lemonsqueezy-cli schema refund-order
lemonsqueezy-cli update-subscription --help
lemonsqueezy-cli cancel-subscription --helpSetup examples deliberately inspect contracts instead of issuing financial actions. --confirm authorizes the exact requested effect, not the correctness of IDs, amounts, consent or provider permissions. Whole JSON:API bodies use payload or an absolute regular non-symlink payload_file, never mixed with flat body flags.
Check a license independently
Configure the purchased license key privately, then validate-license deliberately. valid false is a native verdict returned as data, not an HTTP transport error. Native activated false or deactivated false is an unsuccessful effect. Activation requires instance_name; validation optionally includes instance_id; deactivation requires instance_id. Activation/deactivation require confirm. Main API license management uses Bearer credentials; the independent License API uses the license key itself.
lemonsqueezy-cli validate-license --agent
lemonsqueezy-cli activate-license --help
lemonsqueezy-cli deactivate-license --helpCheck the native result's product/store context privately before integrating license decisions into an application. Key mode and entitlement are not inferred from a profile name. Ordinary tool results never echo the license key.
Create private checkouts and invoice receipts
create_checkout, generate_order_invoice and generate_subscription_invoice require a NEW absolute output_file and confirm. The file is reserved before any native request; an existing path fails without sending the effect. Native signed checkout/invoice URLs stay in the owner-private file; stdout/chat contains only a file receipt. Invoice generation uses POST query fields, no JSON body, and requires native customer address fields including state for US/CA. Checkout bodies use native JSON:API store/variant relationships and reviewed attributes. No URL is followed or media downloaded.
lemonsqueezy-cli create-checkout --help
lemonsqueezy-cli generate-order-invoice --help
lemonsqueezy-cli get-operation-schema --operation create_checkout --agentWebhook configuration sends the reviewed HTTPS callback/event/secret settings to the provider. This package does not start a public listener, verify event delivery or replace your application's signature validation. Keep webhook secrets in private payload files/configuration and out of command transcripts.
2. Quick install
npm install -g @thenavidm/lemonsqueezy-mcp-cli@latest
lemonsqueezy-cli --version
lemonsqueezy-cli tools
lemonsqueezy-cli login3. Set up Lemon Squeezy access
Choose main API and License API credentials separately
- Sign into Lemon Squeezy and use its account API-key settings. Read the current request and authentication guide. Main API keys use Bearer authorization and expire after one year. Create/select a test key for testing, or deliberately select a live key for production. Do not assume a key is restricted to one store merely because a request has store_id.
- Configure exactly one of LEMONSQUEEZY_API_KEY or LEMONSQUEEZY_TOKEN_FILE privately. Set LEMONSQUEEZY_MODE to test or live; the default is test. Before the first main API task in a process, the client reads GET /users/me and checks native meta.test_mode against this setting. A mismatch stops the intended task. A successful check proves key mode, not every permission or store ownership.
- The independent License API uses the purchased license key itself. Configure exactly one of LEMONSQUEEZY_LICENSE_KEY or LEMONSQUEEZY_LICENSE_FILE privately. License operations use form encoding, no Bearer header, and do not require a main API key. Never pass license_key in a tool/CLI argument. A profile's test/live label and main-key check do not establish the license key's mode or product ownership; inspect native result metadata for the intended product/store without publishing it.
- Credential files are absolute, token-only, regular non-symlink files outside repositories, at most 64 KiB. On macOS/Linux use runtime-user ownership and mode 0600, with a private parent directory. Restrict Windows file/directory ACLs separately. GUI, Docker and remote runtimes need credentials in their own environment.
- Run lemonsqueezy-cli doctor for a local configuration check. Deliberate doctor --network checks the main API key with GET /users/me and reports mode metadata without printing native email/user ID. A license-only profile needs validate-license for a deliberate native license verdict; doctor --network cannot validate it without a main key.
login prints instructions only. No OAuth, browser cookies, sign-in, .env loading, key generation or automatic rotation is performed. Keep credentials and customer/billing data out of public issues, command transcripts and repositories. Revoke/replace the intended credential through provider controls and restart all dependent processes; private file credentials cache for the process lifetime.
Private profiles and boundaries
LEMONSQUEEZY_ACCOUNTS is a private JSON array of unique profiles with name, api_key OR token_file, license_key OR license_file, and mode. Both credential types are optional until the relevant operation is requested. Named profiles never inherit global or another profile's credentials. LEMONSQUEEZY_DEFAULT_ACCOUNT selects the default; --account selects an exact configured label. list_accounts prints labels, declared main-key mode and credential-type availability, never secrets, file paths or provider identity. licenseModeVerified remains false.
A store_id filter narrows a list query. An exact resource ID may target a resource outside that filtered store if the key can access it. This package does not claim a store authorization boundary, automatic parent ownership checks, key-fingerprint binding or license-mode proof. Use provider-side least privilege where actually available and review exact IDs before effects.
Native limits and effect outcomes
The main JSON:API and License API publish different rate limits, 300 and 60 requests per minute respectively. Local requests are spaced 1,000 ms by default; other processes share native limits. This local pacing is not a distributed quota guarantee. The initial main-key mode check is an additional native request. Requests have a 30-second default timeout, 1 MiB body and 5 MiB response caps. Redirects and automatic retries are disabled, including 429 and ambiguous transport failures.
Use actual test mode for deliberate commerce tests. Test actions can still generate receipts to account owners/team members; test downloads are restricted. Read-only mode is the local no-effect policy. Do not test refunds, cancellation, billing changes, checkout creation or license activation merely to verify installation. Failed effects may have unknown outcomes: inspect provider state before any deliberate repeat.
4. Connect your client
Full client/OS/desktop details are also in INSTALL.md.
Codex
Codex is the current validation priority. Private token paths must exist in the process or remote environment where the server runs.
codex mcp add lemonsqueezy -- npx -y @thenavidm/lemonsqueezy-mcp-cli@latest
codex mcp listAccount credentials must reach the server through private environment settings. codex mcp add --env NAME=value stores values in your local config, so never commit that config or put secrets in a shared command. In TOML, the equivalent server is:
[mcp_servers.lemonsqueezy]
command = "npx"
args = ["-y", "@thenavidm/lemonsqueezy-mcp-cli@latest"]
env_vars = ["LEMONSQUEEZY_API_KEY", "LEMONSQUEEZY_TOKEN_FILE", "LEMONSQUEEZY_LICENSE_KEY", "LEMONSQUEEZY_LICENSE_FILE", "LEMONSQUEEZY_MODE", "LEMONSQUEEZY_ACCOUNTS", "LEMONSQUEEZY_DEFAULT_ACCOUNT", "LEMONSQUEEZY_READ_ONLY", "LEMONSQUEEZY_ALLOW_DESTRUCTIVE", "LEMONSQUEEZY_AUDIT_LOG", "LEMONSQUEEZY_REQUEST_TIMEOUT_MS", "LEMONSQUEEZY_MIN_REQUEST_INTERVAL_MS"]env_vars forwards those names from the environment available to Codex. If that environment does not contain them, configure private env settings locally. Codex can also call the CLI directly with SKILL.md and --agent output.
Claude Code
For a user-scoped connection, after privately configuring credentials:
claude mcp add --scope user lemonsqueezy -- npx -y @thenavidm/lemonsqueezy-mcp-cli@latest
claude mcp listUse the client's private local environment settings for the account variable if they are not inherited. Claude's -e NAME=value registration option writes values into its config; only use it locally through your secret manager, with no shared command transcript. Never place credentials in a project .mcp.json. Reconnect and ask Claude to verify credentials.
Alternatively install the CLI, make SKILL.md available to Claude, and use shell commands. Registering both surfaces is optional.
Claude Desktop
Install the .mcpb extension
- Download
lemonsqueezy-3.0.0.mcpbfrom GitHub Releases. - In a supported Claude Desktop build, open Settings > Extensions > Advanced settings > Install Extension… and select it.
- Configure the private main API key OR token-only file and its actual test/live mode. Configure the independent license key OR license file only if needed. Leave unused credential sources empty. Named profiles require private manual runtime settings.
- Enable read-only if you want only the 44 read/helper operations. Reconnect and verify the intended profile with one deliberate read.
The bundle includes production dependencies and no credentials. Use a regular private token-only file if you prefer file-based credentials. The manifest requires Node 22 or newer from a compatible host. Organization policy may restrict custom extensions. Manual bundle updates require installing the new version; no automatic directory updates are promised. GUI installation remains unverified separately from archive/protocol checks.
Manual config
Open Settings > Developer > Edit Config, or use your platform's config file:
| OS | Typical config path |
| --- | --- |
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| Windows | %APPDATA%\Claude\claude_desktop_config.json |
| Linux | ~/.config/Claude/claude_desktop_config.json; confirm the location through Edit Config in your installed build |
{
"mcpServers": {
"lemonsqueezy": {
"command": "npx",
"args": ["-y", "@thenavidm/lemonsqueezy-mcp-cli@latest"],
"env": {
"LEMONSQUEEZY_API_KEY": "YOUR_PRIVATE_API_KEY",
"LEMONSQUEEZY_TOKEN_FILE": ""
}
}
}
}Replace the placeholders only in your private file. Merge the server entry into an existing mcpServers object instead of replacing other integrations. Fully quit and reopen Claude Desktop. Do not enable an extension and a manual entry with the same name; choose one route.
If a Windows launcher cannot execute npx directly, use "command": "cmd" with "args": ["/c", "npx", "-y", "@thenavidm/lemonsqueezy-mcp-cli@latest"]. An absolute node executable and installed dist/index.js path also avoids launcher/PATH problems.
Cursor
Use private user settings at ~/.cursor/mcp.json, or Settings > Tools & MCP. Cursor documents environment interpolation and envFile support.
{
"mcpServers": {
"lemonsqueezy": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@thenavidm/lemonsqueezy-mcp-cli@latest"],
"env": {
"LEMONSQUEEZY_API_KEY": "${env:LEMONSQUEEZY_API_KEY}",
"LEMONSQUEEZY_TOKEN_FILE": "${env:LEMONSQUEEZY_TOKEN_FILE}"
}
}
}
}The environment values must exist for the Cursor process. If you use envFile, keep that file private and outside version control. A project .cursor/mcp.json must not contain actual credentials. Reconnect the server after saving.
VS Code and Copilot
Use MCP: Open User Configuration. VS Code uses servers and secure inputs, rather than a mcpServers root:
{
"inputs": [
{"type": "promptString", "id": "lemonsqueezy-api-token", "description": "Lemon Squeezy API key (leave empty for a private token file)", "password": true},
{"type": "promptString", "id": "lemonsqueezy-token-file", "description": "Optional private token-file path (leave empty for API key)"}
],
"servers": {
"lemonsqueezy": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@thenavidm/lemonsqueezy-mcp-cli@latest"],
"env": {
"LEMONSQUEEZY_API_KEY": "${input:lemonsqueezy-api-token}",
"LEMONSQUEEZY_TOKEN_FILE": "${input:lemonsqueezy-token-file}"
}
}
}
}Start Lemon Squeezy through the MCP controls, approve trust if prompted, and enter credentials in the private input prompts. Workspace .vscode/mcp.json may contain this placeholder-only structure, but never resolved secret values. Remote development runs the server in the selected remote environment, so local file paths refer to that environment.
Windsurf
Open Cascade's MCP settings or edit the private user file ~/.codeium/windsurf/mcp_config.json. Use the Claude Desktop manual mcpServers block above with your locally configured env values. See Windsurf's current MCP documentation. Restart or reconnect Lemon Squeezy in Cascade; project files must not contain secrets.
Zed
Open Settings > AI > MCP Servers > Add Server > Add Local Server, or your user settings file. Zed uses context_servers:
{
"context_servers": {
"lemonsqueezy": {
"command": "npx",
"args": ["-y", "@thenavidm/lemonsqueezy-mcp-cli@latest"],
"env": {
"LEMONSQUEEZY_API_KEY": "YOUR_PRIVATE_API_KEY",
"LEMONSQUEEZY_TOKEN_FILE": ""
}
}
}
}Enter actual values only in private user settings. Check the active-server indicator before prompting. Do not wrap command and args inside a nested command object from older Zed examples.
Gemini CLI
Merge the Claude Desktop manual mcpServers block into your private ~/.gemini/settings.json. Configure the private credential values locally, then restart Gemini CLI and inspect /mcp. See Gemini CLI's MCP configuration. Its project settings must not contain real credentials. You can instead use the CLI from an agent shell.
Other local stdio clients use the same command and arguments, adapted to their config format. A client that only accepts a remote MCP URL cannot connect directly: this package does not ship a public HTTP listener. ChatGPT's remote connector setup is not a substitute for local stdio installation.
Docker
Build locally from the reviewed source; no prebuilt registry image is claimed:
git clone https://github.com/thenavidm/lemonsqueezy-mcp-cli.git
cd lemonsqueezy-mcp-cli
docker build -t lemonsqueezy-mcp-cli .
docker run --rm -i -e LEMONSQUEEZY_API_KEY lemonsqueezy-mcp-cliCline and other local MCP clients
Use the client's Add MCP server flow with command npx, arguments -y and @thenavidm/lemonsqueezy-mcp-cli@latest, stdio transport, and private local LEMONSQUEEZY_API_KEY or LEMONSQUEEZY_TOKEN_FILE settings. UI names depend on the installed client. Reconnect and discover tools before an account call. Browser-only clients need a remote HTTPS connector; choose a separately supported remote connector rather than this local stdio command.
All manual examples above configure the main API with default test mode. For a live main key, add LEMONSQUEEZY_MODE=live privately. For independent license operations, add the private LICENSE_KEY or LICENSE_FILE setting separately; never copy an actual license key into a shared config or transcript. The full variable/profile reference below applies to every runtime. A remote-URL-only client cannot directly launch this local stdio server.
5. Check it works
lemonsqueezy-cli --version
lemonsqueezy-cli tools
lemonsqueezy-cli list-accounts --agent
lemonsqueezy-cli doctor
# Deliberate main-key native read only after private configuration
lemonsqueezy-cli doctor --networkDiscovery/help/schema/login are local. doctor --network is one deliberate main-key read; no checkout, refund, billing, license activation or webhook effect is used to test installation. Local protocol checks, provider account outcomes, actual desktop GUI and completed Codex task usage remain separate evidence.
6. Output, flags and exit codes
lemonsqueezy-cli tools --agent
lemonsqueezy-cli list-orders --per-page 5 --agent --select data.id,meta.page
lemonsqueezy-cli schema refund-order--json returns parsed native objects, --compact emits one line, --agent requests compact JSON with no prompts and never confirms, and --select limits model-readable fields. None provides effect approval. Repeated array flags such as --tasks each take one JSON object. Native bodies use payload or an absolute regular non-symlink payload_file capped at 1 MiB. CLI commands use hyphens; MCP names use underscores.
| Exit | Meaning | | --- | --- | | 0 | Success; a license valid:false remains a native data verdict | | 1 | Unexpected error | | 2 | Usage/invalid input/refused effect, an unknown command or a hidden write | | 3 | Not found | | 4 | Authentication/permission | | 5 | Native API/unknown transport error | | 7 | Rate limited | | 10 | Missing/invalid private configuration |
7. MCP or CLI and token cost
MCP can load all schemas, defer discovery or select individual tools; the client's loading mode changes overhead. CLI tasks still need help/schema discovery, command execution and model-readable output. --agent uses compact JSON formatting and --select can narrow results, without changing the requested native operation or proving cheaper successful completion.
Measured on 2026-10-05 against 2.0.1, with Claude Code 2.1.286 on Claude Opus 5.5 (one short prompt with and without the server connected, the difference read from the API's own usage figures) and Codex 0.159.3 on gpt-6.1-sol:
| Cost | 2.0.1 | 3.0.0 |
| --- | --- | --- |
| Claude Code, every tool loaded, every message | 32,838 | 31,362 |
| Claude Code's default, tool search, every message | 1,256 | 1,254 |
| SKILL.md, read once | 3,851 | 3,936 |
| Codex over the CLI, one task, median of five | 61,546 | 61,907 |
| Codex over MCP, the same task, median of five | 41,601 | 41,644 |
The task was "find the command that cancels a subscription, and the flags it requires". Every tool loaded costs less because parts that several tools repeated are written once. Over the CLI, both versions took two commands: 2.0.1's runs guessed the command's name and read its help, and 3.0.0's asked which, whose answer gives the help as well. 3.0.0's general help is longer, for which, install, what each setting is for and the exit codes, which with the answer's list lines costs 361 tokens more. Over MCP, the medians are 43 apart, within the spread of 2.0.1's own runs. SKILL.md costs 85 more because it says how approval works over MCP and how which finds a command, and what exit codes 1 and 2 cover.
Tool-list bytes or characters divided by four are not API usage, and no other offering was measured.
8. Every tool and argument
list_affiliates
Retrieves a paginated list of all affiliates.
| Argument | Type | Required | Meaning and constraints |
| --- | --- | --- | --- |
| page | integer | Optional | Reviewed native/schema value {"minimum": 1} |
| per_page | integer | Optional | Native page size; default10, max100. {"minimum": 1, "maximum": 100} |
| user_email | string | Optional | Exact native filter value. {"minLength": 1} |
| store_id | string | Optional | Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"} |
| account | string | Optional | Exact private profile label. Does not prove store ownership; mode applies to the main API key only. |
lemonsqueezy-cli list-affiliates --help
lemonsqueezy-cli schema list-affiliates{
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Native page size; default10, max100."
},
"user_email": {
"type": "string",
"minLength": 1,
"description": "Exact native filter value."
},
"store_id": {
"type": "string",
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 256,
"description": "Exact native resource ID."
},
"account": {
"type": "string",
"description": "Exact private profile label. Does not prove store ownership; mode applies to the main API key only."
}
},
"required": [],
"additionalProperties": false
}Native request: GET /affiliates. Current provider reference. No native JSON body.
{
"name": "list_affiliates",
"method": "GET",
"path": "/affiliates",
"title": "List affiliates",
"description": "Retrieves a paginated list of all affiliates.",
"group": "affiliates",
"risk": "read",
"params": [
{
"name": "page[number]",
"key": "page",
"schema": {
"type": "integer",
"minimum": 1
},
"in": "query",
"required": false,
"style": "form",
"explode": false
},
{
"name": "page[size]",
"key": "per_page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Native page size; default10, max100."
},
"in": "query",
"required": false,
"style": "form",
"explode": false
},
{
"name": "filter[user_email]",
"key": "user_email",
"schema": {
"type": "string",
"minLength": 1,
"description": "Exact native filter value."
},
"in": "query",
"required": false,
"style": "form",
"explode": false
},
{
"name": "filter[store_id]",
"key": "store_id",
"schema": {
"type": "string",
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 256,
"description": "Exact native resource ID."
},
"in": "query",
"required": false,
"style": "form",
"explode": false
}
],
"bodySchema": null,
"bodyRequired": false,
"privateOutput": false,
"attributes": {},
"attributeRequired": [],
"relationships": {},
"relationshipRequired": [],
"includes": [],
"licenseAPI": false,
"source": "https://docs.lemonsqueezy.com/api/affiliates/list-all-affiliates"
}get_affiliate
Retrieves the affiliate with the given ID.
| Argument | Type | Required | Meaning and constraints |
| --- | --- | --- | --- |
| id | string | Required | Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"} |
| account | string | Optional | Exact private profile label. Does not prove store ownership; mode applies to the main API key only. |
lemonsqueezy-cli get-affiliate --help
lemonsqueezy-cli schema get-affiliate{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "Exact opaque native resource ID; no traversal or URL.",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 256
},
"account": {
"type": "string",
"description": "Exact private profile label. Does not prove store ownership; mode applies to the main API key only."
}
},
"required": [
"id"
],
"additionalProperties": false
}Native request: GET /affiliates/{id}. Current provider reference. No native JSON body.
{
"name": "get_affiliate",
"method": "GET",
"path": "/affiliates/{id}",
"title": "Get affiliate",
"description": "Retrieves the affiliate with the given ID.",
"group": "affiliates",
"risk": "read",
"params": [
{
"name": "id",
"key": "id",
"schema": {
"type": "string",
"minLength": 1,
"description": "Exact opaque native resource ID; no traversal or URL.",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 256
},
"in": "path",
"required": true,
"style": "form",
"explode": false
}
],
"bodySchema": null,
"bodyRequired": false,
"privateOutput": false,
"attributes": {},
"attributeRequired": [],
"relationships": {},
"relationshipRequired": [],
"includes": [],
"licenseAPI": false,
"source": "https://docs.lemonsqueezy.com/api/affiliates/retrieve-affiliate"
}create_checkout
Creates a unique checkout for a specific variant with specified attributes.
| Argument | Type | Required | Meaning and constraints |
| --- | --- | --- | --- |
| custom_price | integer | Optional | Reviewed native/schema value {"minimum": 1} |
| product_options | object | Optional | Reviewed native/schema value |
| product_options.name | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.description | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.media | array | Optional | Reviewed native/schema value {"maxItems": 100} |
| product_options.redirect_url | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.receipt_button_text | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.receipt_link_url | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.receipt_thank_you_note | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.enabled_variants | array | Optional | Reviewed native/schema value {"maxItems": 100} |
| product_options.confirmation_title | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.confirmation_message | string | Optional | Reviewed native/schema value {"minLength": 1} |
| product_options.confirmation_button_text | string | Optional | Reviewed native/schema value {"minLength": 1} |
| checkout_options | object | Optional | Reviewed native/schema value |
| checkout_options.embed | boolean | Optional | Reviewed native/schema value |
| checkout_options.media | boolean | Optional | Reviewed native/schema value |
| checkout_options.logo | boolean | Optional | Reviewed native/schema value |
| checkout_options.desc | boolean | Optional | Reviewed native/schema value |
| checkout_options.discount | boolean | Optional | Reviewed native/schema value |
| checkout_options.skip_trial | boolean | Optional | Reviewed native/schema value |
| checkout_options.subscription_preview | boolean | Optional | Reviewed native/schema value |
| checkout_options.dark | boolean | Optional | Reviewed native/schema value |
| checkout_options.background_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.headings_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.primary_text_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.secondary_text_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.links_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.borders_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.checkbox_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.active_state_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.button_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.button_text_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.terms_privacy_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| checkout_options.locale | ['string', 'null'] | Optional | Reviewed native/schema value {"enum": ["bg", "hr", "cs", "da", "nl", "en", "et", "fil", "fi", "fr", "de", "el", "hu", "id", "it", "ja", "ko", "lv", "lt", "ms", "mt", "pl", "pt", "ro", "ru", "zh-CN", "sk", "sl", "es", "sv", "th", "tr", "vi", null]} |
| checkout_data | object | Optional | Reviewed native/schema value |
| checkout_data.email | string | Optional | Reviewed native/schema value {"minLength": 1, "format": "email"} |
| checkout_data.name | string | Optional | Reviewed native/schema value {"minLength": 1} |
| checkout_data.billing_address | object | Optional | Reviewed native/schema value |
| checkout_data.billing_address.country | string | Optional | Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"} |
| checkout_data.billing_address.zip | string | Optional | Reviewed native/schema value {"minLength": 1} |
| checkout_data.tax_number | string | Optional | Reviewed native/schema value {"minLength": 1} |
| checkout_data.discount_code | string | Optional | Reviewed native/schema value {"minLength": 1} |
| checkout_data.custom | object | Optional | Native custom checkout data. Private and untrusted; never credentials. |
| checkout_data.variant_quantities | array | Optional | Reviewed native/schema value {"maxItems": 100} |
| checkout_data.variant_quantities[].variant_id | integer | Required | Reviewed native/schema value {"minimum": 1} |
| checkout_data.variant_quantities[].quantity | integer | Required | Reviewed native/schema value {"minimum": 1} |
| preview | boolean | Optional | Reviewed native/schema value |
| test_mode | boolean | Optional | Reviewed native/schema value |
| expires_at | ['string', 'null'] | Optional | Reviewed native/schema value {"format": "date-time"} |
| store_id | string | Optional | Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"} |
| variant_id | string | Optional | Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"} |
| account | string | Optional | Exact private profile label. Does not prove store ownership; mode applies to the main API key only. |
| confirm | boolean | Optional | Set true only when the user asked for exactly this action. |
| payload | object | Optional | Complete native JSON object body. JSON:API uses data/type/id/attributes/relationships. No mixing with body flags or payload_file. License credential is private configuration, never body input. |
| payload.data | object | Required | Reviewed native/schema value |
| payload.data.type | schema | Required | Reviewed native/schema value {"const": "checkouts"} |
| payload.data.attributes | object | Required | Reviewed native/schema value |
| payload.data.attributes.custom_price | integer | Optional | Reviewed native/schema value {"minimum": 1} |
| payload.data.attributes.product_options | object | Optional | Reviewed native/schema value |
| payload.data.attributes.product_options.name | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.description | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.media | array | Optional | Reviewed native/schema value {"maxItems": 100} |
| payload.data.attributes.product_options.redirect_url | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.receipt_button_text | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.receipt_link_url | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.receipt_thank_you_note | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.enabled_variants | array | Optional | Reviewed native/schema value {"maxItems": 100} |
| payload.data.attributes.product_options.confirmation_title | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.confirmation_message | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.product_options.confirmation_button_text | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.checkout_options | object | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.embed | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.media | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.logo | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.desc | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.discount | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.skip_trial | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.subscription_preview | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.dark | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_options.background_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.headings_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.primary_text_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.secondary_text_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.links_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.borders_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.checkbox_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.active_state_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.button_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.button_text_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.terms_privacy_color | string | Optional | Native checkout hex color. {"minLength": 1} |
| payload.data.attributes.checkout_options.locale | ['string', 'null'] | Optional | Reviewed native/schema value {"enum": ["bg", "hr", "cs", "da", "nl", "en", "et", "fil", "fi", "fr", "de", "el", "hu", "id", "it", "ja", "ko", "lv", "lt", "ms", "mt", "pl", "pt", "ro", "ru", "zh-CN", "sk", "sl", "es", "sv", "th", "tr", "vi", null]} |
| payload.data.attributes.checkout_data | object | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_data.email | string | Optional | Reviewed native/schema value {"minLength": 1, "format": "email"} |
| payload.data.attributes.checkout_data.name | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.checkout_data.billing_address | object | Optional | Reviewed native/schema value |
| payload.data.attributes.checkout_data.billing_address.country | string | Optional | Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"} |
| payload.data.attributes.checkout_data.billing_address.zip | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.checkout_data.tax_number | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.checkout_data.discount_code | string | Optional | Reviewed native/schema value {"minLength": 1} |
| payload.data.attributes.checkout_data.custom | object | Optional | Native custom checkout data. Private and untrusted; never credentials. |
| payload.data.attributes.checkout_data.variant_quantities | array | Optional | Reviewed native/schema value {"maxItems": 100} |
| payload.data.attributes.checkout_data.variant_quantities[].variant_id | integer | Required | Reviewed native/schema value {"minimum": 1} |
| payload.data.attributes.checkout_data.variant_quantities[].quantity | integer | Required | Reviewed native/schema value {"minimum": 1} |
| payload.data.attributes.preview | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.test_mode | boolean | Optional | Reviewed native/schema value |
| payload.data.attributes.expires_at | ['string', 'null'] | Optional | Reviewed native/schema value {"format": "date-time"} |
| payload.data.relationships | object | Required | Reviewed native/schema value |
| payload.data.relationships.store | object | Required | Reviewed native/schema value |
| payload.data.relationships.store.data | object | Required | Reviewed native/schema value |
| payload.data.relationships.store.data.type | schema | Required | Reviewed native/schema value {"const": "stores"} |
| payload.data.relationships.store.data.id | string | Required | Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"} |
| payload.data.relationships.variant | object | Required | Reviewed native/schema value |
| payload.data.relationships.variant.data | object | Required | Reviewed native/schema value |
| payload.data.relationships.variant.data.type | schema | Required | Reviewed native/schema value {"const": "variants"} |
| payload.data.relationships.variant.data.id | string | Required | Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"} |
| payload_file | string | Optional | Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1} |
| output_file | string | Required | Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite. {"minLength": 1} |
lemonsqueezy-cli create-checkout --help
lemonsqueezy-cli schema create-checkout{
"type": "object",
"properties": {
"custom_price": {
"type": "integer",
"minimum": 1
},
"product_options": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": ""
},
"description": {
"type": "string",
"minLength": 1,
"description": ""
},
"media": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"maxItems": 100
},
"redirect_url": {
"type": "string",
"minLength": 1,
"description": ""
},
"receipt_button_text": {
"type": "string",
"minLength": 1,
"description": ""
},
"receipt_link_url": {
"type": "string",
"minLength": 1,
"description": ""
},
"receipt_thank_you_note": {
"type": "string",
"minLength": 1,
"description": ""
},
"enabled_variants": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 100
},
"confirmation_title": {
"type": "string",
"minLength": 1,
"description": ""
},
"confirmation_message": {
"type": "string",
"minLength": 1,
"description": ""
},
"confirmation_button_text": {
"type": "string",
"minLength": 1,
"description": ""
}
},
"required": [],
"additionalProperties": false
},
"checkout_options": {
"type": "object",
"properties": {
"embed": {
"type": "boolean"
},
"media": {
"type": "boolean"
},
"logo": {
"type": "boolean"
},
"desc": {
"type": "boolean"
},
"discount": {
"type": "boolean"
},
"skip_trial": {
"type": "boolean"
},
"subscription_preview": {
"type": "boolean"
},
"dark": {
"type": "boolean"
},
"background_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"headings_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"primary_text_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"secondary_text_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"links_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"borders_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"checkbox_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"active_state_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"button_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"button_text_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"terms_privacy_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"locale": {
"type": [
"string",
"null"
],
"enum": [
"bg",
"hr",
"cs",
"da",
"nl",
"en",
"et",
"fil",
"fi",
"fr",
"de",
"el",
"hu",
"id",
"it",
"ja",
"ko",
"lv",
"lt",
"ms",
"mt",
"pl",
"pt",
"ro",
"ru",
"zh-CN",
"sk",
"sl",
"es",
"sv",
"th",
"tr",
"vi",
null
]
}
},
"required": [],
"additionalProperties": false
},
"checkout_data": {
"type": "object",
"properties": {
"email": {
"type": "string",
"minLength": 1,
"description": "",
"format": "email"
},
"name": {
"type": "string",
"minLength": 1,
"description": ""
},
"billing_address": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 1,
"description": "",
"pattern": "^[A-Z]{2}$"
},
"zip": {
"type": "string",
"minLength": 1,
"description": ""
}
},
"required": [],
"additionalProperties": false
},
"tax_number": {
"type": "string",
"minLength": 1,
"description": ""
},
"discount_code": {
"type": "string",
"minLength": 1,
"description": ""
},
"custom": {
"type": "object",
"maxProperties": 100,
"description": "Native custom checkout data. Private and untrusted; never credentials."
},
"variant_quantities": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "integer",
"minimum": 1
},
"quantity": {
"type": "integer",
"minimum": 1
}
},
"required": [
"variant_id",
"quantity"
],
"additionalProperties": false
}
}
},
"required": [],
"additionalProperties": false
},
"preview": {
"type": "boolean"
},
"test_mode": {
"type": "boolean"
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"store_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$"
},
"variant_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$"
},
"account": {
"type": "string",
"description": "Exact private profile label. Does not prove store ownership; mode applies to the main API key only."
},
"confirm": {
"type": "boolean",
"description": "Explicit approval for this requested effect, including private output files."
},
"payload": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"const": "checkouts"
},
"attributes": {
"type": "object",
"properties": {
"custom_price": {
"type": "integer",
"minimum": 1
},
"product_options": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": ""
},
"description": {
"type": "string",
"minLength": 1,
"description": ""
},
"media": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"maxItems": 100
},
"redirect_url": {
"type": "string",
"minLength": 1,
"description": ""
},
"receipt_button_text": {
"type": "string",
"minLength": 1,
"description": ""
},
"receipt_link_url": {
"type": "string",
"minLength": 1,
"description": ""
},
"receipt_thank_you_note": {
"type": "string",
"minLength": 1,
"description": ""
},
"enabled_variants": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 100
},
"confirmation_title": {
"type": "string",
"minLength": 1,
"description": ""
},
"confirmation_message": {
"type": "string",
"minLength": 1,
"description": ""
},
"confirmation_button_text": {
"type": "string",
"minLength": 1,
"description": ""
}
},
"required": [],
"additionalProperties": false
},
"checkout_options": {
"type": "object",
"properties": {
"embed": {
"type": "boolean"
},
"media": {
"type": "boolean"
},
"logo": {
"type": "boolean"
},
"desc": {
"type": "boolean"
},
"discount": {
"type": "boolean"
},
"skip_trial": {
"type": "boolean"
},
"subscription_preview": {
"type": "boolean"
},
"dark": {
"type": "boolean"
},
"background_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"headings_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"primary_text_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"secondary_text_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"links_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"borders_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"checkbox_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"active_state_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"button_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"button_text_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"terms_privacy_color": {
"type": "string",
"minLength": 1,
"description": "Native checkout hex color."
},
"locale": {
"type": [
"string",
"null"
],
"enum": [
"bg",
"hr",
"cs",
"da",
"nl",
"en",
"et",
"fil",
"fi",
"fr",
"de",
"el",
"hu",
"id",
"it",
"ja",
"ko",
"lv",
"lt",
"ms",
"mt",
"pl",
"pt",
"ro",
"ru",
"zh-CN",
"sk",
"sl",
"es",
"sv",
"th",
"tr",
"vi",
null
]
}
},
"required": [],
"additionalProperties": false
},
"checkout_data": {
"type": "object",
"properties": {
"email": {
"type": "string",
"minLength": 1,
"description": "",
"format": "email"
},
"name": {
"type": "string",
"minLength": 1,
"description": ""
},
"billing_address": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 1,
"description": "",
"pattern": "^[A-Z]{2}$"
},
"zip": {
"type": "string",
"minLength": 1,
"description": ""
}
},
"required": [],
"additionalProperties": false
},
"tax_number": {
"type": "string",
"minLength": 1,
"description": ""
},
"discount_code": {
"type": "string",
"minLength": 1,
"description": ""
},
"custom": {
"type": "object",
"maxProperties": 100,
"description": "Native custom checkout data. Private and untrusted; never credentials."
},
"variant_quantities": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "integer",
"minimum": 1
},
"quantity": {
"type": "integer",
"minimum": 1
}
},
"required": [
"variant_id",
"quantity"
],
"additionalProperties": false
}
}
},
"required": [],
"additionalProperties": false
},
"preview": {
"type": "boolean"
},
"test_mode": {
"type": "boolean"
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
},
"relationships": {
"type": "object",
"properties": {
"store": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"const": "stores"
},
"id": {
"type": "string",
"minLength": 1,
"description": "Exact opaque native resource ID; no traversal or URL.",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 256
}
},
"required": [
"type",
"id"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
},
"variant": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"const": "variants"
},
"