Actions84
- Affiliate Actions
- Checkout Actions
- Customer Actions
- Discount Actions
- Discount Redemption Actions
- File Actions
- License Key Actions
- License Key Instance Actions
- Order Actions
- Order Item Actions
- Price Actions
- Product Actions
- Store Actions
- Subscription Actions
- Subscription Invoice Actions
- Subscription Item Actions
- Usage Record Actions
- User Actions
- Variant Actions
- Webhook Actions
Subscription → Pause
AI-generatedSummary
Pause a Lemon Squeezy subscription by specifying its ID and pause mode to control billing behavior.
Inputs
- Subscription ID (required) — The ID of the subscription to pause (e.g., "123456").
- Pause Mode (required) — Defines how to pause the subscription: "Void" stops billing entirely; "Free" pauses billing but continues access with free days on resume; "Not Paused" resumes or keeps subscription active.
- Simplify — Optionally simplify the API response by flattening JSON:API attributes; disable to receive raw JSON:API format.
- Retry Options — Configure retry behavior for failed API requests, including max retries and initial delay before retrying.
Output shape
A single JSON object representing the updated subscription resource returned by the Lemon Squeezy API.
The response format depends on the Simplify option: if enabled, JSON:API attributes are flattened; if disabled, the full raw JSON:API structure with 'type', 'attributes', and 'relationships' is returned. The operation requires a valid Subscription ID and Pause Mode to execute successfully. Retry options affect how API request failures are handled.