Lemon Squeezy icon

Lemon Squeezy

Interact with Lemon Squeezy API

Subscription → Update

AI-generated

Summary

Update a Lemon Squeezy subscription by ID, optionally changing its variant, pause state, cancellation setting, billing anchor, proration behavior, invoice timing, or trial end date. Choose whether to return flattened subscription attributes or the raw JSON:API response.

Inputs

  • Subscription ID (required) — The ID of the subscription to update.
  • Update Fields — Optional changes: set a Variant ID to change plans; choose a Pause Mode to keep active, pause without extending billing, or pause with free days on resumption; set Cancelled to control cancellation at the billing period end; set Billing Anchor to a day from 1 to 31; enable Invoice Immediately or Disable Prorations for variant changes; or provide a Trial Ends At date in ISO 8601 format.
  • Simplify — Defaults to true. When enabled, flattens JSON:API attributes to the top level; when disabled, returns the raw JSON:API structure.
  • Retry Options — Configure retry behavior for failed API requests: Max Retries (default 3, range 0–10) and Initial Delay (Ms) (default 1000, range 100–30000; delay doubles on each retry).

Output shape

A single updated subscription record.

The response shape follows Simplify: flattened attributes by default, or raw JSON:API format when disabled.

Links

Discussion