Consulenza sull'IA
Home

Lemon Squeezy MCP Server & CLI

One open source package with 65 shared tasks for commerce, subscriptions, licenses and reviewed private workflows.

githubStar on GitHubnpmnpm
Navid Moazzezdi Navid Moazzez·Aggiornato 3 ott 2026·150 min di lettura·
Valuta questo strumento

This free Lemon Squeezy MCP server and CLI connects your AI to the commerce records and licenses you deliberately select. Read the current catalog, inspect orders and subscriptions, review exact effects and export bounded private metadata.

Both interfaces use the same native contracts, private profiles and approval guard. The official SDK and existing community MCP already cover the native API; this companion adds the owned task CLI and documented local workflows.

key_takeaways.mdTL;DR

Key takeaways

One package provides 65 shared tasks: 44 reads/helpers and 21 confirmed effects.
All 51 legacy tool names remain, with current contracts across 60 distinct native operations.
Main API credentials and independent license credentials stay private and never fall back across profiles.
Exact local commerce reviews and bounded private exports are tested, without provider-state locks or atomic-backup promises.
Current alternatives are credited; equivalent completed Codex task/token savings remain unmeasured.

What is the Lemon Squeezy MCP server & CLI?

One Node package supplies a dedicated task CLI, local stdio MCP and desktop archive. The native scope is 60 reviewed operations plus five local helpers, with selected reviewed fields rather than every dashboard feature or nested relationship URL.

What can you ask it?

Try asking
Read five orders from the store and private profile I selected.
Inspect the subscription and native billing flags before proposing a change.
Review these exact refund and cancellation requests before executing the batch I approve.
Validate my privately configured license without putting the key into chat.
Save a bounded private metadata export to a new file with an explicit continuation receipt.

Install and connect

# Install Lemon Squeezy MCP Server & CLI

One package contains 65 shared tasks, both named binaries and a bundled desktop extension. Node 22+ is required.

Requirements

Install Node and check node --version/npm --version in the actual GUI, container or remote runtime. Windows may require npm.cmd if execution policy blocks npm.ps1. Do not weaken policy or use sudo.

CLI

bash
npm install -g @thenavidm/lemonsqueezy-mcp-cli@latest
lemonsqueezy-cli --version
lemonsqueezy-cli tools
lemonsqueezy-cli login

Alternatively use npx -y --package @thenavidm/lemonsqueezy-mcp-cli@latest lemonsqueezy-cli tools. Put the shipped SKILL.md in your supported private agent skill location; npm does not automatically register it.

Private credential setup

Choose main API and License API credentials separately

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.

Codex

Codex is the current validation priority. Private token paths must exist in the process or remote environment where the server runs.

bash
codex mcp add lemonsqueezy -- npx -y @thenavidm/lemonsqueezy-mcp-cli@latest
codex mcp list

Account 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:

toml
[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:

bash
claude mcp add --scope user lemonsqueezy -- npx -y @thenavidm/lemonsqueezy-mcp-cli@latest
claude mcp list

Use 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

  1. Download lemonsqueezy-2.0.0.mcpb from GitHub Releases.
  2. In a supported Claude Desktop build, open Settings > Extensions > Advanced settings > Install Extension… and select it.
  3. 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.
  4. 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:

OSTypical 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
json
{
  "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.

json
{
  "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:

json
{
  "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:

json
{
  "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:

bash
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-cli

Cline 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.

Verify

bash
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 --network

Discovery/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.

Environment reference

VariablePurpose
LEMONSQUEEZY_API_KEYPrivate main Bearer key; choose this OR TOKEN_FILE
LEMONSQUEEZY_TOKEN_FILEAbsolute owner-private main-key file; choose this OR API_KEY
LEMONSQUEEZY_LICENSE_KEYIndependent purchased license key; choose this OR LICENSE_FILE
LEMONSQUEEZY_LICENSE_FILEAbsolute owner-private license-only file; no main key required for License API
LEMONSQUEEZY_MODEtest (default) or live for global main-key profile; not proof of license mode
LEMONSQUEEZY_ACCOUNTSPrivate array: name, api_key/token_file, license_key/license_file, mode; no fallback
LEMONSQUEEZY_DEFAULT_ACCOUNTExact configured default profile label
LEMONSQUEEZY_READ_ONLY1/true hides and directly refuses all 21 effects
LEMONSQUEEZY_ALLOW_DESTRUCTIVE0/false refuses confirmed effects
LEMONSQUEEZY_AUDIT_LOGOptional private best-effort static guard-decision log
LEMONSQUEEZY_REQUEST_TIMEOUT_MSDefault 30000; local accepted range 100–300000 ms
LEMONSQUEEZY_MIN_REQUEST_INTERVAL_MSDefault 1000; local accepted range 0–10000 ms; not distributed quota enforcement

Updates and removal

Restart npx@latest to resolve an update; upgrade a global CLI with npm install -g @thenavidm/lemonsqueezy-mcp-cli@latest. Install the new .mcpb manually. Remove only the requested registration, skill, extension or global package. Revoke intended native credentials separately and restart after rotation. Removal does not undo financial effects, webhooks or exports.

bash
npm install -g @thenavidm/lemonsqueezy-mcp-cli@latest
lemonsqueezy-cli --version
# Removal only when requested
npm uninstall -g @thenavidm/lemonsqueezy-mcp-cli

Troubleshooting

SymptomCheck
Node/PATH or launcher errorNode 22+ in the actual runtime; npm.cmd for Windows policy constraints
Missing key / exit 10Correct private credential type, exact profile and no credential fallback
Main mode mismatchSelect actual test/live main key and matching explicit profile mode; restart after rotation
License-only doctor --network failsThis checks the main API; use deliberate validate-license with the independent private license credential
valid falseInspect native license verdict and product/store context; transport success is not entitlement
Unreadable private fileAbsolute runtime-readable owner-only regular non-symlink file under 64 KiB; Windows ACLs separately
Invalid body or PATCH idUse native flat fields OR full payload/payload_file; correct type and exact path/body id
Refund refusedPositive native amount OR explicit full_refund true, with confirm and permitted policy
Include/filter refusedUse the actual operation schema; unsupported nested URLs and general sort are not exposed
No signed URL in outputSensitive create/invoice output is in the requested new private file
File already existsChoose another new file; no unrelated overwrite/removal
Review hash mismatchPreview the identical ordered tasks/profile/mode/schema again
429/timeout or partial batchNo retry; inspect native state and known/unattempted indices before a deliberate follow-up
Export incompleteUse receipt filters/page/per_page/start_offset in another new file; no atomic snapshot
401/403Native key expiration/revocation/permission; profile labels do not confer store access
Desktop restrictionSupported host/organization policy and Node 22; protocol discovery is not GUI installation

Development

bash
git clone https://github.com/thenavidm/lemonsqueezy-mcp-cli.git
cd lemonsqueezy-mcp-cli
npm ci
npm run typecheck
npm run build
npm test
npm run check:counts
npm run check:discovery
npm run sync:api -- --check
npm run build:mcpb

Source mode uses node /absolute/path/lemonsqueezy-mcp-cli/dist/index.js after building. Keep credential files outside the checkout and archive.

Output and scripting

bash
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 JSON/compact/no-input/no-color/yes formatting, 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.

ExitMeaning
0Success; a license valid:false remains a native data verdict
2Usage/invalid input/refused effect
3Not found
4Authentication/permission
5Native API/unknown transport error
7Rate limited
10Missing/invalid private configuration

MCP or CLI and measured 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.

Codex is the current validation priority. No equivalent completed provider task/token benchmark exists for this release. Record model, client/package versions, date, loading settings, equivalent requested outcome, actual input/output/cache token usage and latency before publishing measured comparisons. Character estimates, tool counts, synthetic discovery and borrowed integration numbers are not task benchmarks. Claude Code-specific measurements remain deferred at Navid's instruction.

Commerce and license workflows

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.

bash
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-subscription

The 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.

bash
lemonsqueezy-cli refund-order --help
lemonsqueezy-cli schema refund-order
lemonsqueezy-cli update-subscription --help
lemonsqueezy-cli cancel-subscription --help

Setup 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.

bash
lemonsqueezy-cli validate-license --agent
lemonsqueezy-cli activate-license --help
lemonsqueezy-cli deactivate-license --help

Check 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.

bash
lemonsqueezy-cli create-checkout --help
lemonsqueezy-cli generate-order-invoice --help
lemonsqueezy-cli get-operation-schema --operation create_checkout --agent

Webhook 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.

Reviewed batches and bounded exports

Exact locally reviewed commerce work

preview_commerce_batch accepts 1–20 ordered native effects, excluding signed-output operations. Each task contains tool and arguments. Nested arguments cannot override account/confirm or use mutable payload_file/output_file. All tasks are validated before any credential load or network call. The local reviewSha256 binds exact tasks/request order, profile label/mode and reviewed native schema. The digest does not contain loaded credentials or establish provider ownership, amount correctness, state stability, expiry or single use.

bash
lemonsqueezy-cli preview-commerce-batch --tasks '{"tool":"cancel_subscription","arguments":{"id":"REVIEWED_ID"}}' --agent
lemonsqueezy-cli submit-commerce-batch --help

Each repeated --tasks flag contains one task object. Execution requires outer confirm and the identical review_sha256 with unchanged tasks/profile/mode/schema. Credential rotation or upstream changes require renewed human review. A batch is not a transaction: execution stops at the first failure, returns knownResults, failedIndex and unattemptedIndices, and never retries, rolls back or silently continues. A failed request can have an unknown outcome; inspect native state before any deliberate follow-up.

Bounded private JSON:API export

export_resources accepts an actual list operation and its schema-valid filters/page/per_page/include. It saves data and deduplicated included resources to a NEW owner-private file, redacting credentials and signed URLs. File creation is exclusive, mode 0600 on POSIX, with no overwrite or target-symlink following. Restrict Windows ACLs and the parent directory separately.

Budgets default to 10 pages/1,000 items, with local maxima 100 pages/10,000 items and a 5 MiB file cap. Native page counters determine completeness within requested filters. The client never follows links.next. Cap receipts preserve the exact list filters, page/per_page and start_offset for a deliberate resume into another NEW file. A partial-page offset does not freeze provider state; records can change between reads. Included resources can describe the fetched page beyond the selected item cap. Export is not an atomic backup, snapshot, financial reconciliation or file download.

bash
lemonsqueezy-cli export-resources --help
lemonsqueezy-cli schema export-resources

An invalid pagination receipt or failure removes only this operation's newly created partial file, never unrelated data. A native financial effect already sent cannot be undone by deleting an output file or uninstalling the package.

Every tool and argument

list_affiliates

Retrieves a paginated list of all affiliates.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
user_email
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-affiliates --help
lemonsqueezy-cli schema list-affiliates
json
{
  "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.

json
{
  "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.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-affiliate --help
lemonsqueezy-cli schema get-affiliate
json
{
  "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.

json
{
  "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.

custom_price
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
product_options
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
product_options.name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.description
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.media
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"maxItems": 100}
product_options.redirect_url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.receipt_button_text
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.receipt_link_url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.receipt_thank_you_note
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.enabled_variants
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"maxItems": 100}
product_options.confirmation_title
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.confirmation_message
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
product_options.confirmation_button_text
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
checkout_options
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.embed
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.media
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.logo
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.desc
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.discount
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.skip_trial
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.subscription_preview
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.dark
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_options.background_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.headings_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.primary_text_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.secondary_text_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.links_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.borders_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.checkbox_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.active_state_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.button_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.button_text_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.terms_privacy_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
checkout_options.locale
Type
['string', 'null']
Required
Optional
Meaning and constraints
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
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_data.email
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "email"}
checkout_data.name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
checkout_data.billing_address
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
checkout_data.billing_address.country
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"}
checkout_data.billing_address.zip
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
checkout_data.tax_number
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
checkout_data.discount_code
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
checkout_data.custom
Type
object
Required
Optional
Meaning and constraints
Native custom checkout data. Private and untrusted; never credentials.
checkout_data.variant_quantities
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"maxItems": 100}
checkout_data.variant_quantities[].variant_id
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
checkout_data.variant_quantities[].quantity
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
preview
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
test_mode
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
expires_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
store_id
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"}
variant_id
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "checkouts"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.custom_price
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.product_options
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.product_options.name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.description
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.media
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"maxItems": 100}
payload.data.attributes.product_options.redirect_url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.receipt_button_text
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.receipt_link_url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.receipt_thank_you_note
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.enabled_variants
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"maxItems": 100}
payload.data.attributes.product_options.confirmation_title
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.confirmation_message
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.product_options.confirmation_button_text
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.checkout_options
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.embed
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.media
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.logo
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.desc
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.discount
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.skip_trial
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.subscription_preview
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.dark
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_options.background_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.headings_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.primary_text_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.secondary_text_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.links_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.borders_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.checkbox_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.active_state_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.button_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.button_text_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.terms_privacy_color
Type
string
Required
Optional
Meaning and constraints
Native checkout hex color. {"minLength": 1}
payload.data.attributes.checkout_options.locale
Type
['string', 'null']
Required
Optional
Meaning and constraints
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
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_data.email
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "email"}
payload.data.attributes.checkout_data.name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.checkout_data.billing_address
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.checkout_data.billing_address.country
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"}
payload.data.attributes.checkout_data.billing_address.zip
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.checkout_data.tax_number
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.checkout_data.discount_code
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.checkout_data.custom
Type
object
Required
Optional
Meaning and constraints
Native custom checkout data. Private and untrusted; never credentials.
payload.data.attributes.checkout_data.variant_quantities
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"maxItems": 100}
payload.data.attributes.checkout_data.variant_quantities[].variant_id
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.checkout_data.variant_quantities[].quantity
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.preview
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.test_mode
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.expires_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
payload.data.relationships
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "stores"}
payload.data.relationships.store.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload.data.relationships.variant
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.variant.data
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.variant.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "variants"}
payload.data.relationships.variant.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
output_file
Type
string
Required
Required
Meaning and constraints
Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite. {"minLength": 1}
bash
lemonsqueezy-cli create-checkout --help
lemonsqueezy-cli schema create-checkout
json
{
  "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"
                        },
                        "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
                }
              },
              "required": [
                "store",
                "variant"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "attributes",
            "relationships"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    },
    "output_file": {
      "type": "string",
      "minLength": 1,
      "description": "Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite."
    }
  },
  "required": [
    "output_file"
  ],
  "additionalProperties": false
}

Native request: POST /checkouts. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "create_checkout",
  "method": "POST",
  "path": "/checkouts",
  "title": "Create checkout",
  "description": "Creates a unique checkout for a specific variant with specified attributes.",
  "group": "checkouts",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "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"
                      },
                      "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
              }
            },
            "required": [
              "store",
              "variant"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "attributes",
          "relationships"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": true,
  "attributes": {
    "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"
    }
  },
  "attributeRequired": [],
  "relationships": {
    "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"
            },
            "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
    }
  },
  "relationshipRequired": [
    "store",
    "variant"
  ],
  "includes": [
    "store",
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/checkouts/create-checkout"
}

list_checkouts

Returns a paginated list of checkouts.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
variant_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated supported primary relationship names: store, variant. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-checkouts --help
lemonsqueezy-cli schema list-checkouts
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "variant_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated supported primary relationship names: store, variant."
    },
    "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 /checkouts. Current provider reference. No native JSON body.

json
{
  "name": "list_checkouts",
  "method": "GET",
  "path": "/checkouts",
  "title": "List checkouts",
  "description": "Returns a paginated list of checkouts.",
  "group": "checkouts",
  "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[variant_id]",
      "key": "variant_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated supported primary relationship names: store, variant."
      },
      "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": [
    "store",
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/checkouts/list-all-checkouts"
}

get_checkout

Retrieves the checkout with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated supported primary relationship names: store, variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-checkout --help
lemonsqueezy-cli schema get-checkout
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated supported primary relationship names: store, variant."
    },
    "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 /checkouts/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_checkout",
  "method": "GET",
  "path": "/checkouts/{id}",
  "title": "Get checkout",
  "description": "Retrieves the checkout with the given ID.",
  "group": "checkouts",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated supported primary relationship names: store, variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/checkouts/retrieve-checkout"
}

create_customer

Creates a customer with given attributes.

name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
email
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "email"}
city
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
region
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
country
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"}
store_id
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "customers"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.name
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.email
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "email"}
payload.data.attributes.city
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.region
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.country
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"}
payload.data.relationships
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "stores"}
payload.data.relationships.store.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli create-customer --help
lemonsqueezy-cli schema create-customer
json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "email": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "email"
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "region": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "country": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "pattern": "^[A-Z]{2}$"
    },
    "store_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": "customers"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "email": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "format": "email"
                },
                "city": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "region": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "country": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "pattern": "^[A-Z]{2}$"
                }
              },
              "required": [
                "name",
                "email"
              ],
              "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
                }
              },
              "required": [
                "store"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "attributes",
            "relationships"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /customers. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "create_customer",
  "method": "POST",
  "path": "/customers",
  "title": "Create customer",
  "description": "Creates a customer with given attributes.",
  "group": "customers",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "customers"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "email": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "format": "email"
              },
              "city": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "region": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "country": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "pattern": "^[A-Z]{2}$"
              }
            },
            "required": [
              "name",
              "email"
            ],
            "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
              }
            },
            "required": [
              "store"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "attributes",
          "relationships"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "email": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "email"
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "region": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "country": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "pattern": "^[A-Z]{2}$"
    }
  },
  "attributeRequired": [
    "name",
    "email"
  ],
  "relationships": {
    "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
    }
  },
  "relationshipRequired": [
    "store"
  ],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/customers/create-customer"
}

list_customers

Retrieves a paginated list of all customers.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
email
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, orders, subscriptions, license-keys. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-customers --help
lemonsqueezy-cli schema list-customers
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "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."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, orders, subscriptions, license-keys."
    },
    "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 /customers. Current provider reference. No native JSON body.

json
{
  "name": "list_customers",
  "method": "GET",
  "path": "/customers",
  "title": "List customers",
  "description": "Retrieves a paginated list of all customers.",
  "group": "customers",
  "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[email]",
      "key": "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, orders, subscriptions, license-keys."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "orders",
    "subscriptions",
    "license-keys"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/customers/list-all-customers"
}

get_customer

Retrieves the customer with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, orders, subscriptions, license-keys. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-customer --help
lemonsqueezy-cli schema get-customer
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, orders, subscriptions, license-keys."
    },
    "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 /customers/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_customer",
  "method": "GET",
  "path": "/customers/{id}",
  "title": "Get customer",
  "description": "Retrieves the customer with the given ID.",
  "group": "customers",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, orders, subscriptions, license-keys."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "orders",
    "subscriptions",
    "license-keys"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/customers/retrieve-customer"
}

update_customer

Updates the customer with the given ID and provided attributes.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
email
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "email"}
city
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
region
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
country
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"}
status
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["archived"]}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "customers"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.email
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "email"}
payload.data.attributes.city
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.region
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.country
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z]{2}$"}
payload.data.attributes.status
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["archived"]}
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli update-customer --help
lemonsqueezy-cli schema update-customer
json
{
  "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
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "email": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "email"
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "region": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "country": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "pattern": "^[A-Z]{2}$"
    },
    "status": {
      "type": "string",
      "enum": [
        "archived"
      ]
    },
    "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": "customers"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "email": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "format": "email"
                },
                "city": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "region": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "country": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "pattern": "^[A-Z]{2}$"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "archived"
                  ]
                }
              },
              "required": [],
              "additionalProperties": false
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            }
          },
          "required": [
            "type",
            "attributes",
            "id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: PATCH /customers/{id}. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "update_customer",
  "method": "PATCH",
  "path": "/customers/{id}",
  "title": "Update customer",
  "description": "Updates the customer with the given ID and provided attributes.",
  "group": "customers",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "customers"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "email": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "format": "email"
              },
              "city": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "region": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "country": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "pattern": "^[A-Z]{2}$"
              },
              "status": {
                "type": "string",
                "enum": [
                  "archived"
                ]
              }
            },
            "required": [],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          }
        },
        "required": [
          "type",
          "attributes",
          "id"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "email": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "email"
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "region": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "country": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "pattern": "^[A-Z]{2}$"
    },
    "status": {
      "type": "string",
      "enum": [
        "archived"
      ]
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/customers/update-customer"
}

list_discount_redemptions

Returns a paginated list of discount redemptions.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
order_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
discount_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: discount, order. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-discount-redemptions --help
lemonsqueezy-cli schema list-discount-redemptions
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "order_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "discount_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: discount, order."
    },
    "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 /discount-redemptions. Current provider reference. No native JSON body.

json
{
  "name": "list_discount_redemptions",
  "method": "GET",
  "path": "/discount-redemptions",
  "title": "List discount redemptions",
  "description": "Returns a paginated list of discount redemptions.",
  "group": "discount-redemptions",
  "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[order_id]",
      "key": "order_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[discount_id]",
      "key": "discount_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: discount, order."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "discount",
    "order"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/discount-redemptions/list-all-discount-redemptions"
}

get_discount_redemption

Retrieves the discount redemption with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: discount, order. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-discount-redemption --help
lemonsqueezy-cli schema get-discount-redemption
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: discount, order."
    },
    "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 /discount-redemptions/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_discount_redemption",
  "method": "GET",
  "path": "/discount-redemptions/{id}",
  "title": "Get discount redemption",
  "description": "Retrieves the discount redemption with the given ID.",
  "group": "discount-redemptions",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: discount, order."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "discount",
    "order"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/discount-redemptions/retrieve-discount-redemption"
}

create_discount

Create a discount.

name
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
code
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z0-9]{3,256}$"}
amount
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
amount_type
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["fixed", "percent"]}
is_limited_to_products
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
is_limited_redemptions
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
max_redemptions
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
starts_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
expires_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
duration
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["once", "repeating", "forever"]}
duration_in_months
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
test_mode
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
store_id
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"}
variants_ids
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minItems": 1, "maxItems": 100}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "discounts"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.name
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
payload.data.attributes.code
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "pattern": "^[A-Z0-9]{3,256}$"}
payload.data.attributes.amount
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.amount_type
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"enum": ["fixed", "percent"]}
payload.data.attributes.is_limited_to_products
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.is_limited_redemptions
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.max_redemptions
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.starts_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
payload.data.attributes.expires_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
payload.data.attributes.duration
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["once", "repeating", "forever"]}
payload.data.attributes.duration_in_months
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.test_mode
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.relationships
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "stores"}
payload.data.relationships.store.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload.data.relationships.variants
Type
object
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.variants.data
Type
array
Required
Required
Meaning and constraints
Reviewed native/schema value {"minItems": 1, "maxItems": 100}
payload.data.relationships.variants.data[].type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "variants"}
payload.data.relationships.variants.data[].id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli create-discount --help
lemonsqueezy-cli schema create-discount
json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "code": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "pattern": "^[A-Z0-9]{3,256}$"
    },
    "amount": {
      "type": "integer",
      "minimum": 1
    },
    "amount_type": {
      "type": "string",
      "enum": [
        "fixed",
        "percent"
      ]
    },
    "is_limited_to_products": {
      "type": "boolean"
    },
    "is_limited_redemptions": {
      "type": "boolean"
    },
    "max_redemptions": {
      "type": "integer",
      "minimum": 1
    },
    "starts_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "duration": {
      "type": "string",
      "enum": [
        "once",
        "repeating",
        "forever"
      ]
    },
    "duration_in_months": {
      "type": "integer",
      "minimum": 1
    },
    "test_mode": {
      "type": "boolean"
    },
    "store_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$"
    },
    "variants_ids": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "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": "discounts"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                },
                "code": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "pattern": "^[A-Z0-9]{3,256}$"
                },
                "amount": {
                  "type": "integer",
                  "minimum": 1
                },
                "amount_type": {
                  "type": "string",
                  "enum": [
                    "fixed",
                    "percent"
                  ]
                },
                "is_limited_to_products": {
                  "type": "boolean"
                },
                "is_limited_redemptions": {
                  "type": "boolean"
                },
                "max_redemptions": {
                  "type": "integer",
                  "minimum": 1
                },
                "starts_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "expires_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "duration": {
                  "type": "string",
                  "enum": [
                    "once",
                    "repeating",
                    "forever"
                  ]
                },
                "duration_in_months": {
                  "type": "integer",
                  "minimum": 1
                },
                "test_mode": {
                  "type": "boolean"
                }
              },
              "required": [
                "name",
                "code",
                "amount",
                "amount_type"
              ],
              "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
                },
                "variants": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "const": "variants"
                          },
                          "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
                }
              },
              "required": [
                "store"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "attributes",
            "relationships"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /discounts. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "create_discount",
  "method": "POST",
  "path": "/discounts",
  "title": "Create discount",
  "description": "Create a discount.",
  "group": "discounts",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "discounts"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "description": ""
              },
              "code": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "pattern": "^[A-Z0-9]{3,256}$"
              },
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "amount_type": {
                "type": "string",
                "enum": [
                  "fixed",
                  "percent"
                ]
              },
              "is_limited_to_products": {
                "type": "boolean"
              },
              "is_limited_redemptions": {
                "type": "boolean"
              },
              "max_redemptions": {
                "type": "integer",
                "minimum": 1
              },
              "starts_at": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "expires_at": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "duration": {
                "type": "string",
                "enum": [
                  "once",
                  "repeating",
                  "forever"
                ]
              },
              "duration_in_months": {
                "type": "integer",
                "minimum": 1
              },
              "test_mode": {
                "type": "boolean"
              }
            },
            "required": [
              "name",
              "code",
              "amount",
              "amount_type"
            ],
            "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
              },
              "variants": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "array",
                    "minItems": 1,
                    "maxItems": 100,
                    "items": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "const": "variants"
                        },
                        "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
              }
            },
            "required": [
              "store"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "attributes",
          "relationships"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "name": {
      "type": "string",
      "minLength": 1,
      "description": ""
    },
    "code": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "pattern": "^[A-Z0-9]{3,256}$"
    },
    "amount": {
      "type": "integer",
      "minimum": 1
    },
    "amount_type": {
      "type": "string",
      "enum": [
        "fixed",
        "percent"
      ]
    },
    "is_limited_to_products": {
      "type": "boolean"
    },
    "is_limited_redemptions": {
      "type": "boolean"
    },
    "max_redemptions": {
      "type": "integer",
      "minimum": 1
    },
    "starts_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "duration": {
      "type": "string",
      "enum": [
        "once",
        "repeating",
        "forever"
      ]
    },
    "duration_in_months": {
      "type": "integer",
      "minimum": 1
    },
    "test_mode": {
      "type": "boolean"
    }
  },
  "attributeRequired": [
    "name",
    "code",
    "amount",
    "amount_type"
  ],
  "relationships": {
    "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
    },
    "variants": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "minItems": 1,
          "maxItems": 100,
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "const": "variants"
              },
              "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
    }
  },
  "relationshipRequired": [
    "store"
  ],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/discounts/create-discount"
}

delete_discount

Delete a discount with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
bash
lemonsqueezy-cli delete-discount --help
lemonsqueezy-cli schema delete-discount
json
{
  "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."
    },
    "confirm": {
      "type": "boolean",
      "description": "Explicit approval for this requested effect, including private output files."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: DELETE /discounts/{id}. Current provider reference. No native JSON body.

json
{
  "name": "delete_discount",
  "method": "DELETE",
  "path": "/discounts/{id}",
  "title": "Delete discount",
  "description": "Delete a discount with the given ID.",
  "group": "discounts",
  "risk": "destructive",
  "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/discounts/delete-discount"
}

list_discounts

Returns a paginated list of discounts.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, variants, discount-redemptions. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-discounts --help
lemonsqueezy-cli schema list-discounts
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "store_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, variants, discount-redemptions."
    },
    "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 /discounts. Current provider reference. No native JSON body.

json
{
  "name": "list_discounts",
  "method": "GET",
  "path": "/discounts",
  "title": "List discounts",
  "description": "Returns a paginated list of discounts.",
  "group": "discounts",
  "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[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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, variants, discount-redemptions."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "variants",
    "discount-redemptions"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/discounts/list-all-discounts"
}

get_discount

Retrieves the discount with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, variants, discount-redemptions. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-discount --help
lemonsqueezy-cli schema get-discount
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, variants, discount-redemptions."
    },
    "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 /discounts/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_discount",
  "method": "GET",
  "path": "/discounts/{id}",
  "title": "Get discount",
  "description": "Retrieves the discount with the given ID.",
  "group": "discounts",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, variants, discount-redemptions."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "variants",
    "discount-redemptions"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/discounts/retrieve-discount"
}

list_files

Returns a paginated list of files.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
variant_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-files --help
lemonsqueezy-cli schema list-files
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "variant_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: variant."
    },
    "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 /files. Current provider reference. No native JSON body.

json
{
  "name": "list_files",
  "method": "GET",
  "path": "/files",
  "title": "List files",
  "description": "Returns a paginated list of files.",
  "group": "files",
  "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[variant_id]",
      "key": "variant_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/files/list-all-files"
}

get_file

Retrieves the file with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-file --help
lemonsqueezy-cli schema get-file
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: variant."
    },
    "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 /files/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_file",
  "method": "GET",
  "path": "/files/{id}",
  "title": "Get file",
  "description": "Retrieves the file with the given ID.",
  "group": "files",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/files/retrieve-file"
}

activate_license

Use the selected private profile license credential for native activate license. No global API-key fallback; customer metadata stays private.

instance_name
Type
string
Required
Optional
Meaning and constraints
New native activation instance label. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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.instance_name
Type
string
Required
Required
Meaning and constraints
New native activation instance label. {"minLength": 1}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli activate-license --help
lemonsqueezy-cli schema activate-license
json
{
  "type": "object",
  "properties": {
    "instance_name": {
      "type": "string",
      "minLength": 1,
      "description": "New native activation instance label."
    },
    "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": {
        "instance_name": {
          "type": "string",
          "minLength": 1,
          "description": "New native activation instance label."
        }
      },
      "required": [
        "instance_name"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /licenses/activate. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "activate_license",
  "method": "POST",
  "path": "/licenses/activate",
  "title": "Activate license",
  "description": "Use the selected private profile license credential for native activate license. No global API-key fallback; customer metadata stays private.",
  "group": "license-api",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "instance_name": {
        "type": "string",
        "minLength": 1,
        "description": "New native activation instance label."
      }
    },
    "required": [
      "instance_name"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "instance_name": {
      "type": "string",
      "minLength": 1,
      "description": "New native activation instance label."
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": true,
  "source": "https://docs.lemonsqueezy.com/api/license-api/activate-license-key"
}

deactivate_license

Use the selected private profile license credential for native deactivate license. No global API-key fallback; customer metadata stays private.

instance_id
Type
string
Required
Optional
Meaning and constraints
Native instance ID returned by activation. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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.instance_id
Type
string
Required
Required
Meaning and constraints
Native instance ID returned by activation. {"minLength": 1}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli deactivate-license --help
lemonsqueezy-cli schema deactivate-license
json
{
  "type": "object",
  "properties": {
    "instance_id": {
      "type": "string",
      "minLength": 1,
      "description": "Native instance ID returned by activation."
    },
    "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": {
        "instance_id": {
          "type": "string",
          "minLength": 1,
          "description": "Native instance ID returned by activation."
        }
      },
      "required": [
        "instance_id"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /licenses/deactivate. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "deactivate_license",
  "method": "POST",
  "path": "/licenses/deactivate",
  "title": "Deactivate license",
  "description": "Use the selected private profile license credential for native deactivate license. No global API-key fallback; customer metadata stays private.",
  "group": "license-api",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "instance_id": {
        "type": "string",
        "minLength": 1,
        "description": "Native instance ID returned by activation."
      }
    },
    "required": [
      "instance_id"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "instance_id": {
      "type": "string",
      "minLength": 1,
      "description": "Native instance ID returned by activation."
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": true,
  "source": "https://docs.lemonsqueezy.com/api/license-api/deactivate-license-key"
}

validate_license

Use the selected private profile license credential for native validate license. No global API-key fallback; customer metadata stays private.

instance_id
Type
string
Required
Optional
Meaning and constraints
Native instance ID returned by activation. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
payload
Type
object
Required
Optional
Meaning and constraints
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.instance_id
Type
string
Required
Optional
Meaning and constraints
Native instance ID returned by activation. {"minLength": 1}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli validate-license --help
lemonsqueezy-cli schema validate-license
json
{
  "type": "object",
  "properties": {
    "instance_id": {
      "type": "string",
      "minLength": 1,
      "description": "Native instance ID returned by activation."
    },
    "account": {
      "type": "string",
      "description": "Exact private profile label. Does not prove store ownership; mode applies to the main API key only."
    },
    "payload": {
      "type": "object",
      "properties": {
        "instance_id": {
          "type": "string",
          "minLength": 1,
          "description": "Native instance ID returned by activation."
        }
      },
      "required": [],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /licenses/validate. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "validate_license",
  "method": "POST",
  "path": "/licenses/validate",
  "title": "Validate license",
  "description": "Use the selected private profile license credential for native validate license. No global API-key fallback; customer metadata stays private.",
  "group": "license-api",
  "risk": "read",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "instance_id": {
        "type": "string",
        "minLength": 1,
        "description": "Native instance ID returned by activation."
      }
    },
    "required": [],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "instance_id": {
      "type": "string",
      "minLength": 1,
      "description": "Native instance ID returned by activation."
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": true,
  "source": "https://docs.lemonsqueezy.com/api/license-api/validate-license-key"
}

list_license_key_instances

Returns a paginated list of license key instances.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
license_key_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: license-key. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-license-key-instances --help
lemonsqueezy-cli schema list-license-key-instances
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "license_key_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: license-key."
    },
    "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 /license-key-instances. Current provider reference. No native JSON body.

json
{
  "name": "list_license_key_instances",
  "method": "GET",
  "path": "/license-key-instances",
  "title": "List license key instances",
  "description": "Returns a paginated list of license key instances.",
  "group": "license-key-instances",
  "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[license_key_id]",
      "key": "license_key_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: license-key."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "license-key"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/license-key-instances/list-all-license-key-instances"
}

get_license_key_instance

Retrieves the license key instance with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: license-key. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-license-key-instance --help
lemonsqueezy-cli schema get-license-key-instance
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: license-key."
    },
    "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 /license-key-instances/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_license_key_instance",
  "method": "GET",
  "path": "/license-key-instances/{id}",
  "title": "Get license key instance",
  "description": "Retrieves the license key instance with the given ID.",
  "group": "license-key-instances",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: license-key."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "license-key"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/license-key-instances/retrieve-license-key-instance"
}

list_license_keys

Returns a paginated list of license keys.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
order_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
order_item_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
product_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
status
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, license-key-instances. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-license-keys --help
lemonsqueezy-cli schema list-license-keys
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "order_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "order_item_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "product_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "status": {
      "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."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, license-key-instances."
    },
    "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 /license-keys. Current provider reference. No native JSON body.

json
{
  "name": "list_license_keys",
  "method": "GET",
  "path": "/license-keys",
  "title": "List license keys",
  "description": "Returns a paginated list of license keys.",
  "group": "license-keys",
  "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[order_id]",
      "key": "order_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[order_item_id]",
      "key": "order_item_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[product_id]",
      "key": "product_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[status]",
      "key": "status",
      "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, license-key-instances."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "customer",
    "order",
    "order-item",
    "product",
    "license-key-instances"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/license-keys/list-all-license-keys"
}

get_license_key

Retrieves the license key with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, license-key-instances. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-license-key --help
lemonsqueezy-cli schema get-license-key
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, license-key-instances."
    },
    "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 /license-keys/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_license_key",
  "method": "GET",
  "path": "/license-keys/{id}",
  "title": "Get license key",
  "description": "Retrieves the license key with the given ID.",
  "group": "license-keys",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, license-key-instances."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "customer",
    "order",
    "order-item",
    "product",
    "license-key-instances"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/license-keys/retrieve-license-key"
}

update_license_key

Updates the license key with the given ID and provided attributes.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
activation_limit
Type
['integer', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 0}
expires_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
disabled
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "license-keys"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.activation_limit
Type
['integer', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 0}
payload.data.attributes.expires_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
payload.data.attributes.disabled
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli update-license-key --help
lemonsqueezy-cli schema update-license-key
json
{
  "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
    },
    "activation_limit": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "disabled": {
      "type": "boolean"
    },
    "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": "license-keys"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "activation_limit": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 0
                },
                "expires_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "disabled": {
                  "type": "boolean"
                }
              },
              "required": [],
              "additionalProperties": false
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            }
          },
          "required": [
            "type",
            "attributes",
            "id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: PATCH /license-keys/{id}. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "update_license_key",
  "method": "PATCH",
  "path": "/license-keys/{id}",
  "title": "Update license key",
  "description": "Updates the license key with the given ID and provided attributes.",
  "group": "license-keys",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "license-keys"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "activation_limit": {
                "type": [
                  "integer",
                  "null"
                ],
                "minimum": 0
              },
              "expires_at": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "disabled": {
                "type": "boolean"
              }
            },
            "required": [],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          }
        },
        "required": [
          "type",
          "attributes",
          "id"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "activation_limit": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "disabled": {
      "type": "boolean"
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/license-keys/update-license-key"
}

list_order_items

Returns a paginated list of order items.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
product_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
variant_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
order_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: order, product, variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-order-items --help
lemonsqueezy-cli schema list-order-items
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "product_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "variant_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "order_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: order, product, variant."
    },
    "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 /order-items. Current provider reference. No native JSON body.

json
{
  "name": "list_order_items",
  "method": "GET",
  "path": "/order-items",
  "title": "List order items",
  "description": "Returns a paginated list of order items.",
  "group": "order-items",
  "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[product_id]",
      "key": "product_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[variant_id]",
      "key": "variant_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[order_id]",
      "key": "order_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: order, product, variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "order",
    "product",
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/order-items/list-all-order-items"
}

get_order_item

Retrieves the order item with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: order, product, variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-order-item --help
lemonsqueezy-cli schema get-order-item
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: order, product, variant."
    },
    "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 /order-items/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_order_item",
  "method": "GET",
  "path": "/order-items/{id}",
  "title": "Get order item",
  "description": "Retrieves the order item with the given ID.",
  "group": "order-items",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: order, product, variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "order",
    "product",
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/order-items/retrieve-order-item"
}

generate_order_invoice

Generates a new invoice for the given order with given attributes.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
name
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
address
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
city
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
state
Type
string
Required
Optional
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
zip_code
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
country
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
notes
Type
string
Required
Optional
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
locale
Type
string
Required
Optional
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
output_file
Type
string
Required
Required
Meaning and constraints
Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite. {"minLength": 1}
bash
lemonsqueezy-cli generate-order-invoice --help
lemonsqueezy-cli schema generate-order-invoice
json
{
  "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
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "address": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "state": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "zip_code": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "country": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "notes": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "locale": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "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."
    },
    "output_file": {
      "type": "string",
      "minLength": 1,
      "description": "Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite."
    }
  },
  "required": [
    "id",
    "name",
    "address",
    "city",
    "zip_code",
    "country",
    "output_file"
  ],
  "additionalProperties": false
}

Native request: POST /orders/{id}/generate-invoice. Current provider reference. No native JSON body; required invoice fields are query parameters.

json
{
  "name": "generate_order_invoice",
  "method": "POST",
  "path": "/orders/{id}/generate-invoice",
  "title": "Generate order invoice",
  "description": "Generates a new invoice for the given order with given attributes.",
  "group": "orders",
  "risk": "destructive",
  "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
    },
    {
      "name": "name",
      "key": "name",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "address",
      "key": "address",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "city",
      "key": "city",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "state",
      "key": "state",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "zip_code",
      "key": "zip_code",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "country",
      "key": "country",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "notes",
      "key": "notes",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "locale",
      "key": "locale",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": true,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/orders/generate-order-invoice"
}

refund_order

Issue the exact requested partial refund, or an explicitly named full refund. Local approval required; no automatic replay.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
amount
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
full_refund
Type
boolean
Required
Optional
Meaning and constraints
Explicit full-refund intent. Must be true with no amount; cannot coexist with amount.
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "orders"}
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.amount
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli refund-order --help
lemonsqueezy-cli schema refund-order
json
{
  "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
    },
    "amount": {
      "type": "integer",
      "minimum": 1
    },
    "full_refund": {
      "type": "boolean",
      "description": "Explicit full-refund intent. Must be true with no amount; cannot coexist with amount."
    },
    "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": "orders"
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            },
            "attributes": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "integer",
                  "minimum": 1
                }
              },
              "required": [],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "id",
            "attributes"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: POST /orders/{id}/refund. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "refund_order",
  "method": "POST",
  "path": "/orders/{id}/refund",
  "title": "Refund order",
  "description": "Issue the exact requested partial refund, or an explicitly named full refund. Local approval required; no automatic replay.",
  "group": "orders",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "orders"
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          },
          "attributes": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 1
              }
            },
            "required": [],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "id",
          "attributes"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "amount": {
      "type": "integer",
      "minimum": 1
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/orders/issue-refund"
}

list_orders

Returns a paginated list of orders.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
user_email
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
order_number
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, customer, order-items, subscriptions, license-keys, discount-redemptions. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-orders --help
lemonsqueezy-cli schema list-orders
json
{
  "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."
    },
    "order_number": {
      "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."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, customer, order-items, subscriptions, license-keys, discount-redemptions."
    },
    "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 /orders. Current provider reference. No native JSON body.

json
{
  "name": "list_orders",
  "method": "GET",
  "path": "/orders",
  "title": "List orders",
  "description": "Returns a paginated list of orders.",
  "group": "orders",
  "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[order_number]",
      "key": "order_number",
      "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, customer, order-items, subscriptions, license-keys, discount-redemptions."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "customer",
    "order-items",
    "subscriptions",
    "license-keys",
    "discount-redemptions"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/orders/list-all-orders"
}

get_order

Retrieves the order with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, customer, order-items, subscriptions, license-keys, discount-redemptions. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-order --help
lemonsqueezy-cli schema get-order
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, customer, order-items, subscriptions, license-keys, discount-redemptions."
    },
    "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 /orders/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_order",
  "method": "GET",
  "path": "/orders/{id}",
  "title": "Get order",
  "description": "Retrieves the order with the given ID.",
  "group": "orders",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, customer, order-items, subscriptions, license-keys, discount-redemptions."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "customer",
    "order-items",
    "subscriptions",
    "license-keys",
    "discount-redemptions"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/orders/retrieve-order"
}

list_prices

Retrieves a paginated list of prices.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
variant_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-prices --help
lemonsqueezy-cli schema list-prices
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "variant_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: variant."
    },
    "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 /prices. Current provider reference. No native JSON body.

json
{
  "name": "list_prices",
  "method": "GET",
  "path": "/prices",
  "title": "List prices",
  "description": "Retrieves a paginated list of prices.",
  "group": "prices",
  "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[variant_id]",
      "key": "variant_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/prices/list-all-prices"
}

get_price

Retrieves the price with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: variant. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-price --help
lemonsqueezy-cli schema get-price
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: variant."
    },
    "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 /prices/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_price",
  "method": "GET",
  "path": "/prices/{id}",
  "title": "Get price",
  "description": "Retrieves the price with the given ID.",
  "group": "prices",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: variant."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "variant"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/prices/retrieve-price"
}

list_products

Retrieves a paginated list of all products.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, variants. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-products --help
lemonsqueezy-cli schema list-products
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "store_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, variants."
    },
    "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 /products. Current provider reference. No native JSON body.

json
{
  "name": "list_products",
  "method": "GET",
  "path": "/products",
  "title": "List products",
  "description": "Retrieves a paginated list of all products.",
  "group": "products",
  "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[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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, variants."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "variants"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/products/list-all-products"
}

get_product

Retrieves the product with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, variants. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-product --help
lemonsqueezy-cli schema get-product
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, variants."
    },
    "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 /products/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_product",
  "method": "GET",
  "path": "/products/{id}",
  "title": "Get product",
  "description": "Retrieves the product with the given ID.",
  "group": "products",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, variants."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "variants"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/products/retrieve-product"
}

list_stores

Retrieves a paginated list of all stores.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: products, orders, subscriptions, discounts, license-keys, webhooks. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-stores --help
lemonsqueezy-cli schema list-stores
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: products, orders, subscriptions, discounts, license-keys, webhooks."
    },
    "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 /stores. Current provider reference. No native JSON body.

json
{
  "name": "list_stores",
  "method": "GET",
  "path": "/stores",
  "title": "List stores",
  "description": "Retrieves a paginated list of all stores.",
  "group": "stores",
  "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": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: products, orders, subscriptions, discounts, license-keys, webhooks."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "products",
    "orders",
    "subscriptions",
    "discounts",
    "license-keys",
    "webhooks"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/stores/list-all-stores"
}

get_store

Retrieves the store with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: products, orders, subscriptions, discounts, license-keys, webhooks. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-store --help
lemonsqueezy-cli schema get-store
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: products, orders, subscriptions, discounts, license-keys, webhooks."
    },
    "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 /stores/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_store",
  "method": "GET",
  "path": "/stores/{id}",
  "title": "Get store",
  "description": "Retrieves the store with the given ID.",
  "group": "stores",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: products, orders, subscriptions, discounts, license-keys, webhooks."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "products",
    "orders",
    "subscriptions",
    "discounts",
    "license-keys",
    "webhooks"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/stores/retrieve-store"
}

generate_subscription_invoice

Generates a new invoice for the given subscription with given parameters.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
name
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
address
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
city
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
state
Type
string
Required
Optional
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
zip_code
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
country
Type
string
Required
Required
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
notes
Type
string
Required
Optional
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
locale
Type
string
Required
Optional
Meaning and constraints
Native invoice query field; US/CA state is required. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
output_file
Type
string
Required
Required
Meaning and constraints
Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite. {"minLength": 1}
bash
lemonsqueezy-cli generate-subscription-invoice --help
lemonsqueezy-cli schema generate-subscription-invoice
json
{
  "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
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "address": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "state": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "zip_code": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "country": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "notes": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "locale": {
      "type": "string",
      "minLength": 1,
      "description": "Native invoice query field; US/CA state is required."
    },
    "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."
    },
    "output_file": {
      "type": "string",
      "minLength": 1,
      "description": "Required absolute NEW private file for the signed checkout/invoice URL; exclusive0600, no overwrite."
    }
  },
  "required": [
    "id",
    "name",
    "address",
    "city",
    "zip_code",
    "country",
    "output_file"
  ],
  "additionalProperties": false
}

Native request: POST /subscription-invoices/{id}/generate-invoice. Current provider reference. No native JSON body; required invoice fields are query parameters.

json
{
  "name": "generate_subscription_invoice",
  "method": "POST",
  "path": "/subscription-invoices/{id}/generate-invoice",
  "title": "Generate subscription invoice",
  "description": "Generates a new invoice for the given subscription with given parameters.",
  "group": "subscription-invoices",
  "risk": "destructive",
  "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
    },
    {
      "name": "name",
      "key": "name",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "address",
      "key": "address",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "city",
      "key": "city",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "state",
      "key": "state",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "zip_code",
      "key": "zip_code",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "country",
      "key": "country",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": true,
      "style": "form",
      "explode": false
    },
    {
      "name": "notes",
      "key": "notes",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "locale",
      "key": "locale",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Native invoice query field; US/CA state is required."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": true,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "subscription",
    "customer",
    "affiliate"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-invoices/generate-subscription-invoice"
}

refund_subscription_invoice

Issue the exact requested partial refund, or an explicitly named full refund. Local approval required; no automatic replay.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
amount
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
full_refund
Type
boolean
Required
Optional
Meaning and constraints
Explicit full-refund intent. Must be true with no amount; cannot coexist with amount.
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "subscription-invoices"}
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.amount
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli refund-subscription-invoice --help
lemonsqueezy-cli schema refund-subscription-invoice
json
{
  "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
    },
    "amount": {
      "type": "integer",
      "minimum": 1
    },
    "full_refund": {
      "type": "boolean",
      "description": "Explicit full-refund intent. Must be true with no amount; cannot coexist with amount."
    },
    "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": "subscription-invoices"
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            },
            "attributes": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "integer",
                  "minimum": 1
                }
              },
              "required": [],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "id",
            "attributes"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: POST /subscription-invoices/{id}/refund. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "refund_subscription_invoice",
  "method": "POST",
  "path": "/subscription-invoices/{id}/refund",
  "title": "Refund subscription invoice",
  "description": "Issue the exact requested partial refund, or an explicitly named full refund. Local approval required; no automatic replay.",
  "group": "subscription-invoices",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "subscription-invoices"
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          },
          "attributes": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 1
              }
            },
            "required": [],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "id",
          "attributes"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "amount": {
      "type": "integer",
      "minimum": 1
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "subscription",
    "customer",
    "affiliate"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-invoices/issue-refund"
}

list_subscription_invoices

Returns a paginated list of subscription invoices.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
status
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
refunded
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
subscription_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated supported primary relationship names: store, subscription, customer, affiliate. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-subscription-invoices --help
lemonsqueezy-cli schema list-subscription-invoices
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "status": {
      "type": "string",
      "minLength": 1,
      "description": "Exact native filter value."
    },
    "refunded": {
      "type": "boolean"
    },
    "subscription_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated supported primary relationship names: store, subscription, customer, affiliate."
    },
    "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 /subscription-invoices. Current provider reference. No native JSON body.

json
{
  "name": "list_subscription_invoices",
  "method": "GET",
  "path": "/subscription-invoices",
  "title": "List subscription invoices",
  "description": "Returns a paginated list of subscription invoices.",
  "group": "subscription-invoices",
  "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[status]",
      "key": "status",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact native filter value."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[refunded]",
      "key": "refunded",
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[subscription_id]",
      "key": "subscription_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated supported primary relationship names: store, subscription, customer, affiliate."
      },
      "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": [
    "store",
    "subscription",
    "customer"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-invoices/list-all-subscription-invoices"
}

get_subscription_invoice

Retrieves the subscription invoice with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated supported primary relationship names: store, subscription, customer, affiliate. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-subscription-invoice --help
lemonsqueezy-cli schema get-subscription-invoice
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated supported primary relationship names: store, subscription, customer, affiliate."
    },
    "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 /subscription-invoices/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_subscription_invoice",
  "method": "GET",
  "path": "/subscription-invoices/{id}",
  "title": "Get subscription invoice",
  "description": "Retrieves the subscription invoice with the given ID.",
  "group": "subscription-invoices",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated supported primary relationship names: store, subscription, customer, affiliate."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "subscription",
    "customer"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-invoices/retrieve-subscription-invoice"
}

list_subscription_items

Returns a paginated list of subscriptions items.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
price_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated supported primary relationship names: subscription, price, usage-records. {"minLength": 1}
subscription_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-subscription-items --help
lemonsqueezy-cli schema list-subscription-items
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "price_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated supported primary relationship names: subscription, price, usage-records."
    },
    "subscription_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 /subscription-items. Current provider reference. No native JSON body.

json
{
  "name": "list_subscription_items",
  "method": "GET",
  "path": "/subscription-items",
  "title": "List subscription items",
  "description": "Returns a paginated list of subscriptions items.",
  "group": "subscription-items",
  "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[price_id]",
      "key": "price_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated supported primary relationship names: subscription, price, usage-records."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[subscription_id]",
      "key": "subscription_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": [
    "subscription",
    "price",
    "usage-records"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-items/list-all-subscription-items"
}

get_subscription_item_current_usage

Retrieves the unit usage for a subscription item for the current billing period.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-subscription-item-current-usage --help
lemonsqueezy-cli schema get-subscription-item-current-usage
json
{
  "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 /subscription-items/{id}/current-usage. Current provider reference. No native JSON body.

json
{
  "name": "get_subscription_item_current_usage",
  "method": "GET",
  "path": "/subscription-items/{id}/current-usage",
  "title": "Get subscription item current usage",
  "description": "Retrieves the unit usage for a subscription item for the current billing period.",
  "group": "subscription-items",
  "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": [
    "subscription",
    "price",
    "usage-records"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-items/retrieve-subscription-item-current-usage"
}

get_subscription_item

Retrieves the subscription item with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated supported primary relationship names: subscription, price, usage-records. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-subscription-item --help
lemonsqueezy-cli schema get-subscription-item
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated supported primary relationship names: subscription, price, usage-records."
    },
    "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 /subscription-items/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_subscription_item",
  "method": "GET",
  "path": "/subscription-items/{id}",
  "title": "Get subscription item",
  "description": "Retrieves the subscription item with the given ID.",
  "group": "subscription-items",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated supported primary relationship names: subscription, price, usage-records."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "subscription",
    "price",
    "usage-records"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-items/retrieve-subscription-item"
}

update_subscription_item

Updates the subscription with the given ID and provided attributes.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
quantity
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
invoice_immediately
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
disable_prorations
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "subscription-items"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.quantity
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.invoice_immediately
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.disable_prorations
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli update-subscription-item --help
lemonsqueezy-cli schema update-subscription-item
json
{
  "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
    },
    "quantity": {
      "type": "integer",
      "minimum": 1
    },
    "invoice_immediately": {
      "type": "boolean"
    },
    "disable_prorations": {
      "type": "boolean"
    },
    "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": "subscription-items"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "quantity": {
                  "type": "integer",
                  "minimum": 1
                },
                "invoice_immediately": {
                  "type": "boolean"
                },
                "disable_prorations": {
                  "type": "boolean"
                }
              },
              "required": [
                "quantity"
              ],
              "additionalProperties": false
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            }
          },
          "required": [
            "type",
            "attributes",
            "id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: PATCH /subscription-items/{id}. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "update_subscription_item",
  "method": "PATCH",
  "path": "/subscription-items/{id}",
  "title": "Update subscription item",
  "description": "Updates the subscription with the given ID and provided attributes.",
  "group": "subscription-items",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "subscription-items"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "quantity": {
                "type": "integer",
                "minimum": 1
              },
              "invoice_immediately": {
                "type": "boolean"
              },
              "disable_prorations": {
                "type": "boolean"
              }
            },
            "required": [
              "quantity"
            ],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          }
        },
        "required": [
          "type",
          "attributes",
          "id"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "quantity": {
      "type": "integer",
      "minimum": 1
    },
    "invoice_immediately": {
      "type": "boolean"
    },
    "disable_prorations": {
      "type": "boolean"
    }
  },
  "attributeRequired": [
    "quantity"
  ],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "subscription",
    "price",
    "usage-records"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscription-items/update-subscription-item"
}

cancel_subscription

Cancels an active subscription.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
bash
lemonsqueezy-cli cancel-subscription --help
lemonsqueezy-cli schema cancel-subscription
json
{
  "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."
    },
    "confirm": {
      "type": "boolean",
      "description": "Explicit approval for this requested effect, including private output files."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: DELETE /subscriptions/{id}. Current provider reference. No native JSON body.

json
{
  "name": "cancel_subscription",
  "method": "DELETE",
  "path": "/subscriptions/{id}",
  "title": "Cancel subscription",
  "description": "Cancels an active subscription.",
  "group": "subscriptions",
  "risk": "destructive",
  "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/subscriptions/cancel-subscription"
}

list_subscriptions

Returns a paginated list of subscriptions.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
order_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
order_item_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
product_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
variant_id
Type
string
Required
Optional
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
user_email
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
status
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-subscriptions --help
lemonsqueezy-cli schema list-subscriptions
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "order_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "order_item_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "product_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "variant_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact opaque native resource ID; no traversal or URL.",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256
    },
    "user_email": {
      "type": "string",
      "minLength": 1,
      "description": "Exact native filter value."
    },
    "status": {
      "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."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices."
    },
    "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 /subscriptions. Current provider reference. No native JSON body.

json
{
  "name": "list_subscriptions",
  "method": "GET",
  "path": "/subscriptions",
  "title": "List subscriptions",
  "description": "Returns a paginated list of subscriptions.",
  "group": "subscriptions",
  "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[order_id]",
      "key": "order_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[order_item_id]",
      "key": "order_item_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[product_id]",
      "key": "product_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[variant_id]",
      "key": "variant_id",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact opaque native resource ID; no traversal or URL.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 256
      },
      "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[status]",
      "key": "status",
      "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "customer",
    "order",
    "order-item",
    "product",
    "variant",
    "subscription-items",
    "subscription-invoices"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscriptions/list-all-subscriptions"
}

get_subscription

Retrieves the subscription with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-subscription --help
lemonsqueezy-cli schema get-subscription
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices."
    },
    "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 /subscriptions/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_subscription",
  "method": "GET",
  "path": "/subscriptions/{id}",
  "title": "Get subscription",
  "description": "Retrieves the subscription with the given ID.",
  "group": "subscriptions",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store, customer, order, order-item, product, variant, subscription-items, subscription-invoices."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store",
    "customer",
    "order",
    "order-item",
    "product",
    "variant",
    "subscription-items",
    "subscription-invoices"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscriptions/retrieve-subscription"
}

update_subscription

Updates the subscription with the given ID and provided attributes.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
variant_id
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
pause
Type
schema
Required
Optional
Meaning and constraints
Reviewed native/schema value
cancelled
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
trial_ends_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
billing_anchor
Type
['integer', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 0, "maximum": 31}
invoice_immediately
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
disable_prorations
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "subscriptions"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.variant_id
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.pause
Type
schema
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.cancelled
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.trial_ends_at
Type
['string', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"format": "date-time"}
payload.data.attributes.billing_anchor
Type
['integer', 'null']
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 0, "maximum": 31}
payload.data.attributes.invoice_immediately
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.disable_prorations
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli update-subscription --help
lemonsqueezy-cli schema update-subscription
json
{
  "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
    },
    "variant_id": {
      "type": "integer",
      "minimum": 1
    },
    "pause": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "void",
                "free"
              ]
            },
            "resumes_at": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          },
          "required": [
            "mode"
          ],
          "additionalProperties": false
        }
      ]
    },
    "cancelled": {
      "type": "boolean"
    },
    "trial_ends_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "billing_anchor": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 31
    },
    "invoice_immediately": {
      "type": "boolean"
    },
    "disable_prorations": {
      "type": "boolean"
    },
    "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": "subscriptions"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "variant_id": {
                  "type": "integer",
                  "minimum": 1
                },
                "pause": {
                  "anyOf": [
                    {
                      "type": "null"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "void",
                            "free"
                          ]
                        },
                        "resumes_at": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "format": "date-time"
                        }
                      },
                      "required": [
                        "mode"
                      ],
                      "additionalProperties": false
                    }
                  ]
                },
                "cancelled": {
                  "type": "boolean"
                },
                "trial_ends_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "billing_anchor": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 0,
                  "maximum": 31
                },
                "invoice_immediately": {
                  "type": "boolean"
                },
                "disable_prorations": {
                  "type": "boolean"
                }
              },
              "required": [],
              "additionalProperties": false
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            }
          },
          "required": [
            "type",
            "attributes",
            "id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: PATCH /subscriptions/{id}. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "update_subscription",
  "method": "PATCH",
  "path": "/subscriptions/{id}",
  "title": "Update subscription",
  "description": "Updates the subscription with the given ID and provided attributes.",
  "group": "subscriptions",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "subscriptions"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "variant_id": {
                "type": "integer",
                "minimum": 1
              },
              "pause": {
                "anyOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "mode": {
                        "type": "string",
                        "enum": [
                          "void",
                          "free"
                        ]
                      },
                      "resumes_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      }
                    },
                    "required": [
                      "mode"
                    ],
                    "additionalProperties": false
                  }
                ]
              },
              "cancelled": {
                "type": "boolean"
              },
              "trial_ends_at": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "billing_anchor": {
                "type": [
                  "integer",
                  "null"
                ],
                "minimum": 0,
                "maximum": 31
              },
              "invoice_immediately": {
                "type": "boolean"
              },
              "disable_prorations": {
                "type": "boolean"
              }
            },
            "required": [],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          }
        },
        "required": [
          "type",
          "attributes",
          "id"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "variant_id": {
      "type": "integer",
      "minimum": 1
    },
    "pause": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "void",
                "free"
              ]
            },
            "resumes_at": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          },
          "required": [
            "mode"
          ],
          "additionalProperties": false
        }
      ]
    },
    "cancelled": {
      "type": "boolean"
    },
    "trial_ends_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "billing_anchor": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 31
    },
    "invoice_immediately": {
      "type": "boolean"
    },
    "disable_prorations": {
      "type": "boolean"
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/subscriptions/update-subscription"
}

create_usage_record

Create a usage record.

quantity
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
action
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["increment", "set"]}
subscription_item_id
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "usage-records"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.quantity
Type
integer
Required
Required
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
payload.data.attributes.action
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"enum": ["increment", "set"]}
payload.data.relationships
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.subscription-item
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.subscription-item.data
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.subscription-item.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "subscription-items"}
payload.data.relationships.subscription-item.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli create-usage-record --help
lemonsqueezy-cli schema create-usage-record
json
{
  "type": "object",
  "properties": {
    "quantity": {
      "type": "integer",
      "minimum": 1
    },
    "action": {
      "type": "string",
      "enum": [
        "increment",
        "set"
      ]
    },
    "subscription_item_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": "usage-records"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "quantity": {
                  "type": "integer",
                  "minimum": 1
                },
                "action": {
                  "type": "string",
                  "enum": [
                    "increment",
                    "set"
                  ]
                }
              },
              "required": [
                "quantity"
              ],
              "additionalProperties": false
            },
            "relationships": {
              "type": "object",
              "properties": {
                "subscription-item": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "const": "subscription-items"
                        },
                        "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
                }
              },
              "required": [
                "subscription-item"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "attributes",
            "relationships"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /usage-records. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "create_usage_record",
  "method": "POST",
  "path": "/usage-records",
  "title": "Create usage record",
  "description": "Create a usage record.",
  "group": "usage-records",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "usage-records"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "quantity": {
                "type": "integer",
                "minimum": 1
              },
              "action": {
                "type": "string",
                "enum": [
                  "increment",
                  "set"
                ]
              }
            },
            "required": [
              "quantity"
            ],
            "additionalProperties": false
          },
          "relationships": {
            "type": "object",
            "properties": {
              "subscription-item": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "const": "subscription-items"
                      },
                      "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
              }
            },
            "required": [
              "subscription-item"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "attributes",
          "relationships"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "quantity": {
      "type": "integer",
      "minimum": 1
    },
    "action": {
      "type": "string",
      "enum": [
        "increment",
        "set"
      ]
    }
  },
  "attributeRequired": [
    "quantity"
  ],
  "relationships": {
    "subscription-item": {
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "type": {
              "const": "subscription-items"
            },
            "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
    }
  },
  "relationshipRequired": [
    "subscription-item"
  ],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/usage-records/create-usage-record"
}

list_usage_records

Returns a paginated list of usage records.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
subscription_item_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: subscription-item. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-usage-records --help
lemonsqueezy-cli schema list-usage-records
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "subscription_item_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: subscription-item."
    },
    "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 /usage-records. Current provider reference. No native JSON body.

json
{
  "name": "list_usage_records",
  "method": "GET",
  "path": "/usage-records",
  "title": "List usage records",
  "description": "Returns a paginated list of usage records.",
  "group": "usage-records",
  "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[subscription_item_id]",
      "key": "subscription_item_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: subscription-item."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "subscription-item"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/usage-records/list-all-usage-records"
}

get_usage_record

Retrieves the usage record with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: subscription-item. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-usage-record --help
lemonsqueezy-cli schema get-usage-record
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: subscription-item."
    },
    "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 /usage-records/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_usage_record",
  "method": "GET",
  "path": "/usage-records/{id}",
  "title": "Get usage record",
  "description": "Retrieves the usage record with the given ID.",
  "group": "usage-records",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: subscription-item."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "subscription-item"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/usage-records/retrieve-usage-record"
}

get_user

Retrieves the currently authenticated user.

account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-user --help
lemonsqueezy-cli schema get-user
json
{
  "type": "object",
  "properties": {
    "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 /users/me. Current provider reference. No native JSON body.

json
{
  "name": "get_user",
  "method": "GET",
  "path": "/users/me",
  "title": "Get user",
  "description": "Retrieves the currently authenticated user.",
  "group": "users",
  "risk": "read",
  "params": [],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/users/retrieve-user"
}

list_variants

Retrieves a paginated list of variants.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
status
Type
string
Required
Optional
Meaning and constraints
Exact native filter value. {"minLength": 1}
product_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: product, files, price-model. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-variants --help
lemonsqueezy-cli schema list-variants
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "status": {
      "type": "string",
      "minLength": 1,
      "description": "Exact native filter value."
    },
    "product_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: product, files, price-model."
    },
    "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 /variants. Current provider reference. No native JSON body.

json
{
  "name": "list_variants",
  "method": "GET",
  "path": "/variants",
  "title": "List variants",
  "description": "Retrieves a paginated list of variants.",
  "group": "variants",
  "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[status]",
      "key": "status",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Exact native filter value."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    },
    {
      "name": "filter[product_id]",
      "key": "product_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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: product, files, price-model."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "product",
    "files",
    "price-model"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/variants/list-all-variants"
}

get_variant

Retrieves the variant with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: product, files, price-model. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-variant --help
lemonsqueezy-cli schema get-variant
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: product, files, price-model."
    },
    "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 /variants/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_variant",
  "method": "GET",
  "path": "/variants/{id}",
  "title": "Get variant",
  "description": "Retrieves the variant with the given ID.",
  "group": "variants",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: product, files, price-model."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "product",
    "files",
    "price-model"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/variants/retrieve-variant"
}

create_webhook

Creates a webhook.

url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "uri"}
events
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minItems": 1, "maxItems": 100}
secret
Type
string
Required
Optional
Meaning and constraints
Private signing secret; prefer payload_file. Never echo or log. {"minLength": 1}
test_mode
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
store_id
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "webhooks"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.url
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "uri"}
payload.data.attributes.events
Type
array
Required
Required
Meaning and constraints
Reviewed native/schema value {"minItems": 1, "maxItems": 100}
payload.data.attributes.secret
Type
string
Required
Required
Meaning and constraints
Private signing secret; prefer payload_file. Never echo or log. {"minLength": 1}
payload.data.attributes.test_mode
Type
boolean
Required
Optional
Meaning and constraints
Reviewed native/schema value
payload.data.relationships
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.relationships.store.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "stores"}
payload.data.relationships.store.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli create-webhook --help
lemonsqueezy-cli schema create-webhook
json
{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "uri"
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "string",
        "minLength": 1,
        "description": ""
      }
    },
    "secret": {
      "type": "string",
      "minLength": 1,
      "description": "Private signing secret; prefer payload_file. Never echo or log."
    },
    "test_mode": {
      "type": "boolean"
    },
    "store_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": "webhooks"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "format": "uri"
                },
                "events": {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 100,
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "description": ""
                  }
                },
                "secret": {
                  "type": "string",
                  "minLength": 1,
                  "description": "Private signing secret; prefer payload_file. Never echo or log."
                },
                "test_mode": {
                  "type": "boolean"
                }
              },
              "required": [
                "url",
                "events",
                "secret"
              ],
              "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
                }
              },
              "required": [
                "store"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "attributes",
            "relationships"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [],
  "additionalProperties": false
}

Native request: POST /webhooks. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "create_webhook",
  "method": "POST",
  "path": "/webhooks",
  "title": "Create webhook",
  "description": "Creates a webhook.",
  "group": "webhooks",
  "risk": "destructive",
  "params": [],
  "bodySchema": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "webhooks"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "format": "uri"
              },
              "events": {
                "type": "array",
                "minItems": 1,
                "maxItems": 100,
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                }
              },
              "secret": {
                "type": "string",
                "minLength": 1,
                "description": "Private signing secret; prefer payload_file. Never echo or log."
              },
              "test_mode": {
                "type": "boolean"
              }
            },
            "required": [
              "url",
              "events",
              "secret"
            ],
            "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
              }
            },
            "required": [
              "store"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "type",
          "attributes",
          "relationships"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "url": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "uri"
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "string",
        "minLength": 1,
        "description": ""
      }
    },
    "secret": {
      "type": "string",
      "minLength": 1,
      "description": "Private signing secret; prefer payload_file. Never echo or log."
    },
    "test_mode": {
      "type": "boolean"
    }
  },
  "attributeRequired": [
    "url",
    "events",
    "secret"
  ],
  "relationships": {
    "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
    }
  },
  "relationshipRequired": [
    "store"
  ],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/webhooks/create-webhook"
}

delete_webhook

Delete a webhook with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
bash
lemonsqueezy-cli delete-webhook --help
lemonsqueezy-cli schema delete-webhook
json
{
  "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."
    },
    "confirm": {
      "type": "boolean",
      "description": "Explicit approval for this requested effect, including private output files."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: DELETE /webhooks/{id}. Current provider reference. No native JSON body.

json
{
  "name": "delete_webhook",
  "method": "DELETE",
  "path": "/webhooks/{id}",
  "title": "Delete webhook",
  "description": "Delete a webhook with the given ID.",
  "group": "webhooks",
  "risk": "destructive",
  "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/webhooks/delete-webhook"
}

list_webhooks

Returns a paginated list of webhooks.

page
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 1}
per_page
Type
integer
Required
Optional
Meaning and constraints
Native page size; default10, max100. {"minimum": 1, "maximum": 100}
store_id
Type
string
Required
Optional
Meaning and constraints
Exact native resource ID. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli list-webhooks --help
lemonsqueezy-cli schema list-webhooks
json
{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Native page size; default10, max100."
    },
    "store_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 256,
      "description": "Exact native resource ID."
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store."
    },
    "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 /webhooks. Current provider reference. No native JSON body.

json
{
  "name": "list_webhooks",
  "method": "GET",
  "path": "/webhooks",
  "title": "List webhooks",
  "description": "Returns a paginated list of webhooks.",
  "group": "webhooks",
  "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[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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/webhooks/list-all-webhooks"
}

get_webhook

Retrieves the webhook with the given ID.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
include
Type
string
Required
Optional
Meaning and constraints
Comma-separated native relationships from pinned official SDK: store. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
bash
lemonsqueezy-cli get-webhook --help
lemonsqueezy-cli schema get-webhook
json
{
  "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
    },
    "include": {
      "type": "string",
      "minLength": 1,
      "description": "Comma-separated native relationships from pinned official SDK: store."
    },
    "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 /webhooks/{id}. Current provider reference. No native JSON body.

json
{
  "name": "get_webhook",
  "method": "GET",
  "path": "/webhooks/{id}",
  "title": "Get webhook",
  "description": "Retrieves the webhook with the given ID.",
  "group": "webhooks",
  "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
    },
    {
      "name": "include",
      "key": "include",
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Comma-separated native relationships from pinned official SDK: store."
      },
      "in": "query",
      "required": false,
      "style": "form",
      "explode": false
    }
  ],
  "bodySchema": null,
  "bodyRequired": false,
  "privateOutput": false,
  "attributes": {},
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [
    "store"
  ],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/webhooks/retrieve-webhook"
}

update_webhook

Updates the webhook with the given ID and provided attributes.

id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "uri"}
events
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minItems": 1, "maxItems": 100}
secret
Type
string
Required
Optional
Meaning and constraints
Private replacement signing secret; prefer payload_file. {"minLength": 1}
account
Type
string
Required
Optional
Meaning and constraints
Exact private profile label. Does not prove store ownership; mode applies to the main API key only.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this requested effect, including private output files.
payload
Type
object
Required
Optional
Meaning and constraints
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
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.type
Type
schema
Required
Required
Meaning and constraints
Reviewed native/schema value {"const": "webhooks"}
payload.data.attributes
Type
object
Required
Required
Meaning and constraints
Reviewed native/schema value
payload.data.attributes.url
Type
string
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minLength": 1, "format": "uri"}
payload.data.attributes.events
Type
array
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minItems": 1, "maxItems": 100}
payload.data.attributes.secret
Type
string
Required
Optional
Meaning and constraints
Private replacement signing secret; prefer payload_file. {"minLength": 1}
payload.data.id
Type
string
Required
Required
Meaning and constraints
Exact opaque native resource ID; no traversal or URL. {"minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9_-]+$"}
payload_file
Type
string
Required
Optional
Meaning and constraints
Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. {"minLength": 1}
bash
lemonsqueezy-cli update-webhook --help
lemonsqueezy-cli schema update-webhook
json
{
  "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
    },
    "url": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "uri"
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "string",
        "minLength": 1,
        "description": ""
      }
    },
    "secret": {
      "type": "string",
      "minLength": 1,
      "description": "Private replacement signing secret; prefer payload_file."
    },
    "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": "webhooks"
            },
            "attributes": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string",
                  "minLength": 1,
                  "description": "",
                  "format": "uri"
                },
                "events": {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 100,
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "description": ""
                  }
                },
                "secret": {
                  "type": "string",
                  "minLength": 1,
                  "description": "Private replacement signing secret; prefer payload_file."
                }
              },
              "required": [],
              "additionalProperties": false
            },
            "id": {
              "type": "string",
              "minLength": 1,
              "description": "Exact opaque native resource ID; no traversal or URL.",
              "pattern": "^[A-Za-z0-9_-]+$",
              "maxLength": 256
            }
          },
          "required": [
            "type",
            "attributes",
            "id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false,
      "description": "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_file": {
      "type": "string",
      "minLength": 1,
      "description": "Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Native request: PATCH /webhooks/{id}. Current provider reference. Use native body flags OR payload OR payload_file; never mixed.

json
{
  "name": "update_webhook",
  "method": "PATCH",
  "path": "/webhooks/{id}",
  "title": "Update webhook",
  "description": "Updates the webhook with the given ID and provided attributes.",
  "group": "webhooks",
  "risk": "destructive",
  "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": {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "type": {
            "const": "webhooks"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "minLength": 1,
                "description": "",
                "format": "uri"
              },
              "events": {
                "type": "array",
                "minItems": 1,
                "maxItems": 100,
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "description": ""
                }
              },
              "secret": {
                "type": "string",
                "minLength": 1,
                "description": "Private replacement signing secret; prefer payload_file."
              }
            },
            "required": [],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Exact opaque native resource ID; no traversal or URL.",
            "pattern": "^[A-Za-z0-9_-]+$",
            "maxLength": 256
          }
        },
        "required": [
          "type",
          "attributes",
          "id"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  },
  "bodyRequired": true,
  "privateOutput": false,
  "attributes": {
    "url": {
      "type": "string",
      "minLength": 1,
      "description": "",
      "format": "uri"
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "string",
        "minLength": 1,
        "description": ""
      }
    },
    "secret": {
      "type": "string",
      "minLength": 1,
      "description": "Private replacement signing secret; prefer payload_file."
    }
  },
  "attributeRequired": [],
  "relationships": {},
  "relationshipRequired": [],
  "includes": [],
  "licenseAPI": false,
  "source": "https://docs.lemonsqueezy.com/api/webhooks/update-webhook"
}

list_accounts

Local profile labels/default/auth method only. No keys, token paths, provider identity or network request.

bash
lemonsqueezy-cli list-accounts --help
lemonsqueezy-cli schema list-accounts
json
{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

get_operation_schema

Local reviewed method/path/query/body schema and provenance for one native tool. No credentials or provider request.

operation
Type
string
Required
Required
Meaning and constraints
Exact native tool name, e.g. update_subscription or refund_order. {"enum": ["list_affiliates", "get_affiliate", "create_checkout", "list_checkouts", "get_checkout", "create_customer", "list_customers", "get_customer", "update_customer", "list_discount_redemptions", "get_discount_redemption", "create_discount", "delete_discount", "list_discounts", "get_discount", "list_files", "get_file", "activate_license", "deactivate_license", "validate_license", "list_license_key_instances", "get_license_key_instance", "list_license_keys", "get_license_key", "update_license_key", "list_order_items", "get_order_item", "generate_order_invoice", "refund_order", "list_orders", "get_order", "list_prices", "get_price", "list_products", "get_product", "list_stores", "get_store", "generate_subscription_invoice", "refund_subscription_invoice", "list_subscription_invoices", "get_subscription_invoice", "list_subscription_items", "get_subscription_item_current_usage", "get_subscription_item", "update_subscription_item", "cancel_subscription", "list_subscriptions", "get_subscription", "update_subscription", "create_usage_record", "list_usage_records", "get_usage_record", "get_user", "list_variants", "get_variant", "create_webhook", "delete_webhook", "list_webhooks", "get_webhook", "update_webhook"]}
bash
lemonsqueezy-cli get-operation-schema --help
lemonsqueezy-cli schema get-operation-schema
json
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "list_affiliates",
        "get_affiliate",
        "create_checkout",
        "list_checkouts",
        "get_checkout",
        "create_customer",
        "list_customers",
        "get_customer",
        "update_customer",
        "list_discount_redemptions",
        "get_discount_redemption",
        "create_discount",
        "delete_discount",
        "list_discounts",
        "get_discount",
        "list_files",
        "get_file",
        "activate_license",
        "deactivate_license",
        "validate_license",
        "list_license_key_instances",
        "get_license_key_instance",
        "list_license_keys",
        "get_license_key",
        "update_license_key",
        "list_order_items",
        "get_order_item",
        "generate_order_invoice",
        "refund_order",
        "list_orders",
        "get_order",
        "list_prices",
        "get_price",
        "list_products",
        "get_product",
        "list_stores",
        "get_store",
        "generate_subscription_invoice",
        "refund_subscription_invoice",
        "list_subscription_invoices",
        "get_subscription_invoice",
        "list_subscription_items",
        "get_subscription_item_current_usage",
        "get_subscription_item",
        "update_subscription_item",
        "cancel_subscription",
        "list_subscriptions",
        "get_subscription",
        "update_subscription",
        "create_usage_record",
        "list_usage_records",
        "get_usage_record",
        "get_user",
        "list_variants",
        "get_variant",
        "create_webhook",
        "delete_webhook",
        "list_webhooks",
        "get_webhook",
        "update_webhook"
      ],
      "description": "Exact native tool name, e.g. update_subscription or refund_order."
    }
  },
  "required": [
    "operation"
  ],
  "additionalProperties": false
}

preview_commerce_batch

Local validation and SHA-256 of exact inputs, request order, selected profile label/mode and reviewed native schema. No provider requests, secret load, store ownership check or financial guarantee.

tasks
Type
array
Required
Required
Meaning and constraints
One to twenty exact ordered commerce effects. No signed-output operations or mutable payload files. Financial effects require explicit native amount/full-refund intent; subscription changes can charge or alter recurring billing. {"minItems": 1, "maxItems": 20}
tasks[].tool
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"enum": ["create_customer", "update_customer", "create_discount", "delete_discount", "activate_license", "deactivate_license", "update_license_key", "refund_order", "refund_subscription_invoice", "update_subscription_item", "cancel_subscription", "update_subscription", "create_usage_record", "create_webhook", "delete_webhook", "update_webhook"]}
tasks[].arguments
Type
object
Required
Required
Meaning and constraints
Native arguments without account, confirm, payload_file or output_file.
account
Type
string
Required
Optional
Meaning and constraints
Exact selected private account profile; binds label, not key ownership.
bash
lemonsqueezy-cli preview-commerce-batch --help
lemonsqueezy-cli schema preview-commerce-batch
json
{
  "type": "object",
  "properties": {
    "tasks": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20,
      "description": "One to twenty exact ordered commerce effects. No signed-output operations or mutable payload files. Financial effects require explicit native amount/full-refund intent; subscription changes can charge or alter recurring billing.",
      "items": {
        "type": "object",
        "properties": {
          "tool": {
            "type": "string",
            "enum": [
              "create_customer",
              "update_customer",
              "create_discount",
              "delete_discount",
              "activate_license",
              "deactivate_license",
              "update_license_key",
              "refund_order",
              "refund_subscription_invoice",
              "update_subscription_item",
              "cancel_subscription",
              "update_subscription",
              "create_usage_record",
              "create_webhook",
              "delete_webhook",
              "update_webhook"
            ]
          },
          "arguments": {
            "type": "object",
            "description": "Native arguments without account, confirm, payload_file or output_file."
          }
        },
        "required": [
          "tool",
          "arguments"
        ],
        "additionalProperties": false
      }
    },
    "account": {
      "type": "string",
      "description": "Exact selected private account profile; binds label, not key ownership."
    }
  },
  "required": [
    "tasks"
  ],
  "additionalProperties": false
}

submit_commerce_batch

Confirmed one-to-twenty ordered effects. Prevalidate all and check the exact review hash before the first request. Stop on first failure with known results and unattempted indices; no retry, transaction, rollback or implicit continuation.

tasks
Type
array
Required
Required
Meaning and constraints
One to twenty exact ordered commerce effects. No signed-output operations or mutable payload files. Financial effects require explicit native amount/full-refund intent; subscription changes can charge or alter recurring billing. {"minItems": 1, "maxItems": 20}
tasks[].tool
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"enum": ["create_customer", "update_customer", "create_discount", "delete_discount", "activate_license", "deactivate_license", "update_license_key", "refund_order", "refund_subscription_invoice", "update_subscription_item", "cancel_subscription", "update_subscription", "create_usage_record", "create_webhook", "delete_webhook", "update_webhook"]}
tasks[].arguments
Type
object
Required
Required
Meaning and constraints
Native arguments without account, confirm, payload_file or output_file.
account
Type
string
Required
Optional
Meaning and constraints
Exact selected private account profile; binds label, not key ownership.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this exact requested ordered batch.
review_sha256
Type
string
Required
Required
Meaning and constraints
Exact preview_commerce_batch hash for identical tasks, selected profile/mode/schema/order. {"pattern": "^[a-f0-9]{64}$"}
bash
lemonsqueezy-cli submit-commerce-batch --help
lemonsqueezy-cli schema submit-commerce-batch
json
{
  "type": "object",
  "properties": {
    "tasks": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20,
      "description": "One to twenty exact ordered commerce effects. No signed-output operations or mutable payload files. Financial effects require explicit native amount/full-refund intent; subscription changes can charge or alter recurring billing.",
      "items": {
        "type": "object",
        "properties": {
          "tool": {
            "type": "string",
            "enum": [
              "create_customer",
              "update_customer",
              "create_discount",
              "delete_discount",
              "activate_license",
              "deactivate_license",
              "update_license_key",
              "refund_order",
              "refund_subscription_invoice",
              "update_subscription_item",
              "cancel_subscription",
              "update_subscription",
              "create_usage_record",
              "create_webhook",
              "delete_webhook",
              "update_webhook"
            ]
          },
          "arguments": {
            "type": "object",
            "description": "Native arguments without account, confirm, payload_file or output_file."
          }
        },
        "required": [
          "tool",
          "arguments"
        ],
        "additionalProperties": false
      }
    },
    "account": {
      "type": "string",
      "description": "Exact selected private account profile; binds label, not key ownership."
    },
    "confirm": {
      "type": "boolean",
      "description": "Explicit approval for this exact requested ordered batch."
    },
    "review_sha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "description": "Exact preview_commerce_batch hash for identical tasks, selected profile/mode/schema/order."
    }
  },
  "required": [
    "tasks",
    "review_sha256"
  ],
  "additionalProperties": false
}

export_resources

Confirmed paginated JSON:API export to a new exclusive0600 file. Preserves data and included resources while redacting credentials/signed URLs. Uses native page counters, never follows links, downloads files or promises an atomic backup.

operation
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"enum": ["list_affiliates", "list_checkouts", "list_customers", "list_discount_redemptions", "list_discounts", "list_files", "list_license_key_instances", "list_license_keys", "list_order_items", "list_orders", "list_prices", "list_products", "list_stores", "list_subscription_invoices", "list_subscription_items", "list_subscriptions", "list_usage_records", "list_variants", "list_webhooks"]}
arguments
Type
object
Required
Optional
Meaning and constraints
Actual selected list-operation filters/page/per_page/include only; no profile override.
account
Type
string
Required
Optional
Meaning and constraints
Exact selected private account profile; binds label, not key ownership.
confirm
Type
boolean
Required
Optional
Meaning and constraints
Explicit approval for this exact requested ordered batch.
start_offset
Type
integer
Required
Optional
Meaning and constraints
Reviewed native/schema value {"minimum": 0, "maximum": 99}
max_pages
Type
integer
Required
Optional
Meaning and constraints
Local budget default10. {"minimum": 1, "maximum": 100}
max_items
Type
integer
Required
Optional
Meaning and constraints
Local budget default1000. {"minimum": 1, "maximum": 10000}
output_file
Type
string
Required
Required
Meaning and constraints
Reviewed native/schema value {"minLength": 1}
bash
lemonsqueezy-cli export-resources --help
lemonsqueezy-cli schema export-resources
json
{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "list_affiliates",
        "list_checkouts",
        "list_customers",
        "list_discount_redemptions",
        "list_discounts",
        "list_files",
        "list_license_key_instances",
        "list_license_keys",
        "list_order_items",
        "list_orders",
        "list_prices",
        "list_products",
        "list_stores",
        "list_subscription_invoices",
        "list_subscription_items",
        "list_subscriptions",
        "list_usage_records",
        "list_variants",
        "list_webhooks"
      ]
    },
    "arguments": {
      "type": "object",
      "description": "Actual selected list-operation filters/page/per_page/include only; no profile override."
    },
    "account": {
      "type": "string",
      "description": "Exact selected private account profile; binds label, not key ownership."
    },
    "confirm": {
      "type": "boolean",
      "description": "Explicit approval for this exact requested ordered batch."
    },
    "start_offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 99
    },
    "max_pages": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Local budget default10."
    },
    "max_items": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "description": "Local budget default1000."
    },
    "output_file": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "operation",
    "output_file"
  ],
  "additionalProperties": false
}

Writing safely

All 19 native effects plus batch execution and private export require explicit local confirm. LEMONSQUEEZY_READ_ONLY=1 hides all 21 effects and refuses direct hidden confirmed calls through the actual handler. LEMONSQUEEZY_ALLOW_DESTRUCTIVE=0 refuses them even when confirmed. --agent and --yes change output/input formatting only, never approval. The same guard covers CLI and MCP, including POST license activation/deactivation and signed-output generation.

READ_ONLY controls this process, not other clients or provider automations. Native access rights, financial correctness, license entitlement and customer authorization stay separate. Main-key mode checks are native reads, not store ownership checks. A local review hash is not a provider-issued approval token or state lock. No automatic retries or guessed continuations are performed after an uncertain effect.

Your data

Credentials are private process settings or owner-private token-only files; no .env database, browser session or credential store is shipped. Raw keys/license credentials and known signed credential URLs are removed from ordinary tool output and errors. Signed-output tasks deliberately save their native response only to the requested new private file. Other customer/order/billing fields remain sensitive and are not anonymized.

Audit logging is optional, private and best-effort for static guard decisions; it is not a verified ledger, native settlement evidence or full access log. Avoid copying customer data, private review payloads and signed receipts into public screenshots, repositories, issues or agents without a business need. Native text and URLs are untrusted data. Removing an integration does not delete exports, reverse refunds, cancel webhooks or undo subscription changes.

Environment variables

VariablePurpose
LEMONSQUEEZY_API_KEYPrivate main Bearer key; choose this OR TOKEN_FILE
LEMONSQUEEZY_TOKEN_FILEAbsolute owner-private main-key file; choose this OR API_KEY
LEMONSQUEEZY_LICENSE_KEYIndependent purchased license key; choose this OR LICENSE_FILE
LEMONSQUEEZY_LICENSE_FILEAbsolute owner-private license-only file; no main key required for License API
LEMONSQUEEZY_MODEtest (default) or live for global main-key profile; not proof of license mode
LEMONSQUEEZY_ACCOUNTSPrivate array: name, api_key/token_file, license_key/license_file, mode; no fallback
LEMONSQUEEZY_DEFAULT_ACCOUNTExact configured default profile label
LEMONSQUEEZY_READ_ONLY1/true hides and directly refuses all 21 effects
LEMONSQUEEZY_ALLOW_DESTRUCTIVE0/false refuses confirmed effects
LEMONSQUEEZY_AUDIT_LOGOptional private best-effort static guard-decision log
LEMONSQUEEZY_REQUEST_TIMEOUT_MSDefault 30000; local accepted range 100–300000 ms
LEMONSQUEEZY_MIN_REQUEST_INTERVAL_MSDefault 1000; local accepted range 0–10000 ms; not distributed quota enforcement

Official and community comparisons

Official API and SDK

The current native API and official lemonsqueezy.js SDK already cover JSON:API commerce and independent license operations. SDK 4.0.0 is pinned at b1f66e905ee0614be87c3711d6529f2582e5729f for source cross-checking; it is not a runtime dependency. This package exposes 60 distinct reviewed native operations and five local workflow helpers. Coverage is a reviewed field subset, not every SDK option, nested relationship URL or dashboard feature.

No official provider MCP or dedicated task CLI was identified in the reviewed primary documentation and searches on October 3, 2026. This is a search finding, not proof of absence. Recheck before future releases. Generic terminal MCP clients are also valid alternatives to building a dedicated task CLI.

Existing community implementations

YawLabs/lemonsqueezy-mcp is pinned at 7dfff25e0117470c6fa2335b1067cd111eb01e6b, package 1.0.1. Its source already provides pagination, correct License API transport, class permission gates, refund caps, a bounded audit ring, rate-limit retries, optional private secret-vault fetching and an optional webhook sink. Its 64 declared tools include 61 native tool names and three webhook helpers; archive_customer aliases the customer update route, so the native route count is 60. Credit those existing capabilities. The published source describes limitations of store filtering for ID-targeted operations.

The reviewed refund/license handlers and wrapper use class preflight and policy controls, without this package's mandatory per-call confirm field. This package's actual shared handlers add explicit effect approval and direct read-only refusal, isolated private test/live profiles, a dedicated task CLI, exact ordered commerce review hashes and bounded private JSON:API exports. The comparison is pinned source review plus this candidate's local behavior fixtures. No matched live provider or competitor runtime benchmark is claimed.

atharvagupta2003/mcp-lemonsqueezy declares 17 tools in its README at the pinned commit. Its full runtime was not verified, so that statement is a README finding only.

When this companion is useful

Choose it for the owned shared task CLI/local MCP, private profiles, explicit per-effect approval, exact locally reviewed batches and bounded file exports. Choose another implementation for its useful native or webhook/vault features where they better match your workflow. This package does not host a webhook listener, implement payment settlement, run OAuth, create products, promise store-scoped authorization or offer every dashboard action. No blanket superiority, unique CLI availability, greater total tool coverage or measured token saving is claimed.

Native operations
This implementation
60 distinct reviewed routes, 65 shared tasks
Existing tooling
Official SDK and YawLabs already cover the native routes
Task CLI
This implementation
Same schemas, handlers and approval as local MCP
Existing tooling
SDK integration and generic MCP terminal clients remain alternatives
Profiles
This implementation
Two private credential types; main-key mode checked; no fallback
Existing tooling
Provider-side permission still governs accessible stores/resources
Approval
This implementation
All 21 local/native effects require explicit confirm
Existing tooling
YawLabs already has class gates and refund caps
Reviewed batches
This implementation
Exact local inputs/order/profile label/mode/schema hash; stop on failure
Existing tooling
No provider state lock, transaction, rollback or single-use guarantee
Private export
This implementation
Native counters, budgets, resume offsets, exclusive file, redacted signed URLs
Existing tooling
Metadata export, not atomic backup or digital-file download
Webhooks
This implementation
Create/read/update/delete native configuration
Existing tooling
YawLabs additionally offers an optional local sink
Cost evidence
This implementation
Matched completed Codex tasks remain unmeasured
Existing tooling
Schema counts or another provider benchmark are not task-token savings

Versions and migration

ComponentReviewed version/evidence
Package/desktop2.0.0; public source/npm/desktop verification recorded separately
Native APIv1, 60 reviewed operations checked 2026-10-03
Official SDK4.0.0, pinned source only
YawLabs community1.0.1 at 7dfff25e0117470c6fa2335b1067cd111eb01e6b
Node>=22
Private legacy1.0.0, all 51 tool names preserved
Codex task/token comparisonPending actual equivalent provider outcomes
Legacy contractCurrent requirement
51 native tool namesAll preserved; current schemas and major argument changes apply
Global main key required at startupCredential-free discovery; independent license-only configuration works
License key in tool arguments/JSON Bearer requestPrivate LICENSE_KEY/LICENSE_FILE; native form encoding without Authorization
Unconfirmed refunds or omitted amountExplicit confirm plus amount OR full_refund true
Opaque arbitrary body fieldsReviewed typed JSON:API body, matching ids/relationships; reject unknown fields
Invoice JSON bodyNative POST query fields plus required new private output_file
Signed checkout URL in chatNew private output_file reserved before effect
Legacy SDK 1.x/Zod schemasCurrent shared TypeScript/SDK/Ajv bridge; 65 tools/44 reads/21 approved effects
No dedicated task binarylemonsqueezy-cli and lemonsqueezy-mcp from scoped package
Old source historyIntact private legacy remains separate; only sanitized fresh public snapshot is published

See CHANGELOG.md. Private history is preserved separately; sanitized publishing begins from a fresh verified snapshot, preserving AGPL-3.0.

More tools for your commerce workflow

Connect only the services your requested customer and publishing work needs.

Kit MCP server & CLICircle MCP server & CLIWordPress MCP server & CLI

Lemon Squeezy MCP Server & CLI FAQs

Current alternatives, private profiles, commerce approval, native licenses, bounded exports and maintenance.

The package preserves AGPL-3.0.

Provider services, merchant eligibility and native access remain separate.

Read LICENSE and the provider terms before redistribution or service use.

Use it when you want the shared task CLI/local MCP, isolated private profiles, mandatory per-effect approval, exact locally reviewed batches and bounded private exports.

The official SDK and YawLabs already cover the native routes; no universal superiority is claimed.

No official provider MCP or dedicated task CLI was identified in the reviewed primary sources on October 3, 2026.

That is a dated search finding, not proof of absence.

Official SDK and generic MCP terminal clients remain alternatives.

65 shared tasks: 44 reads/helpers and 21 explicitly confirmed effects.

They cover 60 distinct reviewed native operations plus five local helpers.

READ_ONLY exposes 44.

Count route aliases separately when comparing another MCP.

The main JSON:API uses a private Bearer API key created in the intended test/live mode.

Configure one key or token file.

API keys expire after one year; check current native access and permissions.

A profile label does not restrict provider visibility to a store.

No.

Configure the purchased license key privately using LICENSE_KEY or LICENSE_FILE.

The native form-encoded License API has no Bearer header.

Do not pass the license credential in tool arguments or shared command transcripts.

No.

The main-key mode check compares native meta.test_mode with the declared profile mode.

READ_ONLY hides and directly refuses effects.

License key mode is not proven by that main-key check or the profile label; test effects can still cause native test notifications.

Use the private ACCOUNTS array with unique names and explicit credential sources/mode.

DEFAULT_ACCOUNT or --account chooses an exact label.

Named profiles never fall back to global or another profile credentials; incomplete profiles fail only when that credential type is needed.

No. store_id narrows supported list queries, while a resource ID can target anything visible to the key.

This package does not claim automatic store ownership validation.

Use actual provider permissions and review IDs before effects.

The same tool definitions, input schemas, native request compiler, account selection and WriteGuard serve both.

The house CLI invokes the actual MCP server through SDK in-memory transport; no separate API implementation is maintained.

Use explicit confirm for the exact requested task and configure local policy to allow it. --agent/--yes never provide approval.

READ_ONLY or ALLOW_DESTRUCTIVE=0 refuses effects even with confirm.

Approval does not prove the amount, ownership, entitlement or customer permission.

Partial refunds require a positive integer amount in the native smallest currency unit.

Full refunds require explicit full_refund true without amount.

Omission alone and combining the two are refused.

Inspect current provider state after ambiguous failures; do not automatically repeat.

Native variant, quantity, invoice/proration and pause changes can affect billing.

Inspect the exact subscription and native contract first.

DELETE cancellation does not prove immediate access revocation or final settlement; this wrapper adds no financial guarantee.

These three native tasks require a new absolute private output_file and confirm.

The file is exclusively reserved before network effects.

Native sensitive URLs stay there; output contains only the receipt.

The client does not follow the URL, overwrite existing files or download invoices.

It binds exact local tasks, request order, profile label/mode and reviewed schema.

It does not bind loaded credentials, freeze provider state, expire, guarantee single use, validate store ownership or make the batch atomic.

Re-review after credential or upstream changes.

No.

It is a budgeted JSON:API metadata export with native counters, included resources and explicit resume offsets.

Credentials/signed URLs are redacted.

It is not atomic, does not follow returned links, and does not download digital files or promise financial reconciliation.

No automatic retry is performed, including 429, timeout and unknown financial outcomes.

Local default pacing is 1,000 ms with a 30-second timeout.

Main and License API quotas differ, and other processes may share them.

Inspect native state before repeating.

Codex, Claude Code, Claude Desktop extension/manual settings, Cursor, VS Code/Copilot, Windsurf, Zed, Gemini CLI, Docker and compatible local stdio clients are documented for their supported macOS/Windows/Linux runtimes.

Remote-URL-only clients need another connector.

Actual desktop GUI acceptance is separate from archive discovery.

That remains unmeasured for equivalent completed Codex provider tasks.

Client loading mode, discovery, output and task outcome all matter. --agent/--select can narrow formatting/results, but tool counts and character estimates are not token benchmarks.

Update the scoped npm package or restart npx@latest, reconnect clients, and install the new desktop bundle manually.

Revoke intended credentials separately and restart after rotation.

Uninstalling does not undo provider effects or private files.

Report reproducible secret-free issues; use private security reporting for sensitive matters.

Navid Moazzez

AI business strategist & AI OS builder

Navid Moazzez helps creators and founders master AI and build their own AI Operating System (AI OS) to automate their business and life.

Navid.me is reader-supported. When you buy through links on this site, I may earn an affiliate commission. Learn more.

More MCP servers & CLIs

View all

Kit MCP server & CLI

Draft newsletters, manage subscribers and tags, inspect email stats and automate Kit API v4.

NewsletterskitKit

Circle MCP server & CLI

Read members and spaces, draft posts and perform requested Circle Admin API v2 actions.

CommunitiesCircle

WordPress MCP server & CLI

Edit posts, pages, Elementor and Rank Math SEO on WordPress from Claude, Codex or Cursor.

BlogsWordPress

Bluesky MCP server & CLI

Post, read and search Bluesky from Claude, Codex or Cursor, or from your terminal.

Social mediablueskyBluesky

Substack MCP server & CLI

Draft posts, publish Notes and check your stats on Substack from Claude, Codex or Cursor.

NewsletterssubstackSubstack

Threads MCP server & CLI

Post, reply and read your insights on Threads from Claude, Codex or Cursor.

Social mediathreadsThreads

Mastodon MCP server & CLI

Post, edit and read your timelines on any Mastodon instance from Claude, Codex or Cursor.

Social mediamastodonMastodon

TikTok MCP server & CLI

Rank your videos, read your stats and publish to TikTok from Claude, Codex or Cursor.

Social mediatiktokTikTok

ThriveCart MCP server & CLI

Check revenue, customers, subscriptions and affiliates in ThriveCart from Claude, Codex or Cursor.

SalesThriveCart

Midjourney MCP server & CLI

Generate images, follow jobs and download the files from Midjourney with Claude, Codex or Cursor.

AI imagesMidjourney

Google Photos MCP server & CLI

Pick photos, build albums and upload to Google Photos from Claude, Codex or Cursor.

PhotosGoogle Photos

Apple Photos MCP server & CLI

Search, look at and organize your Apple Photos library from Claude, Codex or Cursor, on your Mac.

PhotosApple Photos

Apple Podcasts MCP server & CLI

Track chart ranks, read reviews and search your podcast library from Claude, Codex or Cursor.

Podcastsapple-podcastsApple Podcasts

Podcast Index MCP server & CLI

Search 4 million podcasts and read episode transcripts from Claude, Codex or Cursor.

PodcastsPodcast Index

Google Search Console MCP server & CLI

Read your search traffic, check indexing and submit sitemaps from Claude, Codex or Cursor.

SEOGoogle Search Console

Google Workspace MCP server & CLI

Work across Gmail, Drive, Sheets, Docs and Calendar from Claude, Codex or Cursor.

ProductivityGoogle Workspace

iMessage MCP server & CLI

Catch up, search your history and send iMessages from Claude, Codex or Cursor, on your Mac.

MessagingiMessage

Facebook Ad Library MCP server & CLI

Research the ads any brand runs on Facebook and Instagram, from Claude, Codex or Cursor.

ResearchfacebookFacebook

Vimeo MCP server & CLI

Read transcripts, file videos into folders and add chapters from Claude, Codex or Cursor.

VideoVimeo

YouTube MCP server & CLI

Read any video's transcript, research channels and manage your own from Claude, Codex or Cursor.

VideoyoutubeYouTube

Telegram MCP server & CLI

Catch up, search years of chats and reply on Telegram from Claude, Codex or Cursor.

MessagingtelegramTelegram

Adobe Firefly MCP server & CLI

Generate and edit images, make videos and composite products through Adobe Firefly Services.

AI imagesAdobe Firefly

OP3 MCP server & CLI

Read your podcast's downloads, real listeners and retention from Claude, Codex or Cursor.

PodcastsOP3

Beehiiv MCP server & CLI

Draft newsletters, inspect subscriber lists and analytics, and automate Beehiiv API v2.

NewslettersbeehiivBeehiiv

Calendly MCP server & CLI

Find slots, book approved meetings and work with Calendly contacts and meeting recaps.

SalesCalendly

Wistia MCP server & CLI

Work with videos, captions, uploads, analytics and approved Wistia account actions.

VideoWistia

ScrapeCreators MCP server & CLI

Research public profiles, transcripts, comments and ads with explicit paid-call approval.

Social mediaScrapeCreators

Shotstack MCP server & CLI

Render, manage templates and inspect media with private profiles and confirmed operations.

VideoShotstack

Gumloop MCP server & CLI

Inspect flows and agents, run approved automation and handle files privately.

ProductivityGumloop

Buffer MCP server & CLI

Inspect publishing data, review drafts and execute only approved mutations.

Social mediaBuffer

Cloudflare MCP server & CLI

Inspect DNS and review exact requests before approving zone changes.

ProductivityCloudflare

Bannerbear MCP server & CLI

Inspect templates, review exact render batches and run approved media workflows.

AI imagesBannerbear

Brandfetch MCP server & CLI

Retrieve brand data, compare identities and save approved private assets.

ResearchBrandfetch

Creatomate MCP server & CLI

Inspect templates, validate designs and submit exact approved render batches.

VideoCreatomate

Dub MCP server & CLI

Manage requested short links and partner work with private profiles and exact approval.

SalesDub

fal.ai MCP server & CLI

Discover models, review exact approved generation and manage requested Assets.

Videofal.ai

Flodesk MCP server & CLI

Manage requested subscribers, drafts, workflows, custom fields and webhooks.

SalesflodeskFlodesk

Fluent WordPress MCP server & CLI

Read CRM, Community and Forms; apply approved native tasks and save private snapshots.

SalesWordPress

Senja MCP server & CLI

Find proof, review exact changes and export bounded private testimonials.

SalesSenja

Testimonial.to MCP server & CLI

Read ready proof, review authorized imports and save private bounded exports.

SalesTestimonial.to

Gumroad MCP server & CLI

Read sales, verify private licenses and review exact effects.

SalesGumroad

Fourthwall MCP server & CLI

Manage selected Fourthwall shop tasks from a shared CLI or local MCP.

SalesFourthwall

Teachable MCP server & CLI

Teachable school workflows through a shared CLI or local MCP.

SalesTeachable

Related free tools

Tutti gli strumenti gratuiti

X character counter

Counts the way X counts: links as 23, emoji as 2. LinkedIn, Instagram, TikTok, Threads and YouTube limits too.

ScrivoxXblueskyBluesky

LinkedIn character counter

LinkedIn's 3,000-character post limit, counted as you type, with X, Threads and Bluesky beside it.

ScrivolinkedinLinkedIn

Threads character counter

Threads' 500-character limit, counted as you type, with X, Bluesky and LinkedIn beside it.

ScrivothreadsThreads

Bluesky character counter

Bluesky's 300-character limit, counted the way the protocol counts, with X and Threads beside it.

ScrivoblueskyBluesky

Mastodon character counter

Mastodon's 500-character default, counted the way Mastodon counts links and mentions.

ScrivomastodonMastodon

Instagram character counter

Instagram's 2,200-character caption limit, counted as you type, with TikTok and the rest beside it.

ScrivoinstagramInstagram

TikTok character counter

TikTok's 2,200 caption limit, counted the way TikTok counts it, with emoji as 2.

ScrivotiktokTikTok

Pinterest character counter

Pin titles (100) and descriptions (800), counted as you type.

ScrivopinterestPinterest

YouTube character counter

YouTube titles (100) and descriptions (5,000), counted as you type.

ScrivoyoutubeYouTube

llms.txt generator

Build your llms.txt from your live site, check every link and your AI crawler access, and add llms-full.txt.

AIQualsiasi sito

UTM builder

Clean UTM links, the GA4 channel each one lands in, presets for creators, and many links at once.

Link e QRQualsiasi sito

Schema markup generator

Schema markup (JSON-LD) for the types Google shows today, checked against Google's own rules, plus a check for any page.

SEOQualsiasi sito
Newsletter IA gratuita

La newsletter IA più pratica per i founder

Ogni settimana, strategie IA collaudate, strumenti selezionati e sistemi passo dopo passo per far crescere il tuo pubblico, creare contenuti migliori e costruire un business da creator redditizio.

Niente fronzoli, niente riempitivi, niente fuffa. Solo cinque minuti a settimana che possono portare il tuo business online e la tua vita al livello successivo.

P.S. Iscriviti ora per avere accesso gratuito alla mia guida definitiva agli strumenti IA per creator.

Amata da oltre 10.000 lettori