Lemon Squeezy icon

Lemon Squeezy

Interact with Lemon Squeezy API

Checkout → Create

AI-generated

Summary

Creates a Lemon Squeezy checkout for a chosen store and variant, returning the new checkout record including its hosted checkout URL. Supports pre-filled customer and billing data, product overrides, custom pricing, discounts, and display styling.

Inputs

  • Store (required) — Store the checkout belongs to. Pick from the list or supply an ID via expression.
  • Variant (required) — Variant to check out. The list is filtered by the selected store; an ID can also be given via expression.
  • Additional Options — Optional checkout settings: custom price (cents, for pay-what-you-want), discount code, pre-filled email, name, billing country, zip and tax number, redirect URL, receipt button text, link and thank-you note, custom data (JSON passed to webhooks), expiry (ISO 8601), skip trial, test mode, variant quantity overrides (JSON array), product name, description and media URL overrides, enabled variants (comma-separated IDs), and Shorten URL (returns checkout_short_url).
  • Checkout Display Options — Appearance settings: hex colors for background, buttons, text, links, borders, headings, checkbox, active state and terms/privacy; embed mode; and toggles to show or hide logo, media, description, discount field and subscription preview.
  • Simplify — Defaults to true. Flattens the JSON:API response so attributes sit at the top level. Turn off for the raw type, attributes and relationships format.
  • Retry Options — Max Retries (default 3, 0 disables) and Initial Delay in ms (default 1000, doubled on each retry) for failed API requests.

Output shape

One item for the created checkout. By default it is flattened, with id, type and the attributes (including the checkout URL) at the top level. With Simplify off, it is the raw JSON:API resource.

The source pack shows only signature-level handler code, so how each option maps to API fields is not visible. Custom data is subject to the node's validation (10KB size limit, max nesting depth 10), and URL and email inputs are validated before the API call. The short URL is only returned when Shorten URL is enabled. Rate-limit (429) and 5xx errors are retried.

Examples

Example 1: Generate a pre-filled checkout link for a new lead from a CRM trigger.

Select Store and Variant; in Additional Options set Customer Email and Name from the incoming data, a Discount Code, and enable Shorten URL.

Example 2: Create a branded, expiring test checkout.

Set Test Mode on, Expires At to a future ISO date, Redirect URL, and Button Color and Background Color in Checkout Display Options.

Example 3: Sell a pay-what-you-want product with metadata for webhooks.

Set Custom Price in cents and Custom Data JSON such as {"user_id":"42"}.

Links

Discussion