Lemon Squeezy
App · 19 actions
Sell software and digital products with Lemon Squeezy: make checkout links, read and refund orders, manage subscriptions, discount codes and license keys. Start a workflow on a new order or subscription.
Actions
| Action | What it does |
|---|---|
| Cancel subscription | Cancel a subscription; the customer keeps it until the period they paid for ends. |
| Change subscription plan | Move a subscription to another product or price, such as monthly to yearly. |
| Check license key | Check whether a license key is valid, and whose it is, as your app would. |
| Create checkout link | Make a checkout link for a product, with the buyer's details and a discount filled in. |
| Create discount code | Create a discount code for a store, as a percent or an amount off. |
| Delete discount code | Delete a discount code, so it can no longer be used. |
| Find customers | Find customers by store or email, with what they have spent. |
| Find license keys | Find the license keys sold by a store, with an order or for a product. |
| Get order | Get one order: who bought what, what they paid and their receipt. |
| Get subscription | Get one subscription, with links the customer can use to manage it or update their card. |
| List discount codes | List a store's discount codes. |
| List orders | List orders, newest first, for a store or a buyer's email. |
| List products | List a store's products, each with its prices. |
| List stores | List the account's stores with their sales. |
| List subscriptions | List subscriptions by store, status, customer email or product. |
| Pause subscription | Stop charging a subscription for now, until a date or until it is resumed. |
| Refund order | Refund an order in full, or part of it. |
| Resume subscription | Start charging a paused subscription again, or keep a cancelled one from ending. |
| Update license key | Turn a license key off or on, or change how many devices or how long it works. |
Cancel subscription
Cancel a subscription; the customer keeps it until the period they paid for ends.
Inputs
- Subscription
subscriptiontextRequired - The subscription's ID, from 'List subscriptions' or the 'New subscription' trigger.
Outputs
cancelledtrue/false- True when it ends at the period's end
card_brandtext- The card's brand, such as visa
card_last_fourtext- The card's last four digits
created_attext- When it started (ISO 8601)
customer_emailtext- The customer's email address
customer_idtext- The customer's ID
customer_nametext- The customer's name
customer_portal_urltext- Where the customer manages it (works for 24 hours)
ends_attext- When a cancelled one ends (ISO 8601)
idtext- The subscription's ID
order_idtext- The order that started it
pause_modetext- void (keep access, no charge) or free; empty if not paused
pausedtrue/false- True when payments are paused
product_idtext- The product's ID
product_nametext- The product
renews_attext- When it next renews (ISO 8601)
resumes_attext- When a pause ends (ISO 8601); empty if not set
statustext- on_trial, active, paused, past_due, unpaid, cancelled or expired
test_modetrue/false- True for a test-mode subscription
trial_ends_attext- When a trial ends (ISO 8601)
update_payment_urltext- Where the customer updates their card (works for 24 hours)
variant_idtext- The price's ID
variant_nametext- The price, such as Monthly
Example output
{
"cancelled": true,
"card_brand": "visa",
"card_last_four": "4242",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"customer_portal_url": "https://example.lemonsqueezy.com/billing?expires=1",
"ends_at": "2027-10-27T10:00:00.000000Z",
"id": "301",
"order_id": "1001",
"pause_mode": "",
"paused": false,
"product_id": "10",
"product_name": "Pro plan",
"renews_at": "2027-10-27T10:00:00.000000Z",
"resumes_at": "",
"status": "cancelled",
"test_mode": false,
"trial_ends_at": "",
"update_payment_url": "https://example.lemonsqueezy.com/subscription/301/payment-details",
"variant_id": "11",
"variant_name": "Yearly"
}Change subscription plan
Move a subscription to another product or price, such as monthly to yearly.
Inputs
- Subscription
subscriptiontextRequired - The subscription's ID, from 'List subscriptions' or the 'New subscription' trigger.
- Product price
varianttextRequired - The product and price to move it to.
- Charge the difference now
charge_nowtrue/false - Charge the prorated difference now rather than at the next renewal. Off by default.Default:
false.
Outputs
cancelledtrue/false- True when it ends at the period's end
card_brandtext- The card's brand, such as visa
card_last_fourtext- The card's last four digits
created_attext- When it started (ISO 8601)
customer_emailtext- The customer's email address
customer_idtext- The customer's ID
customer_nametext- The customer's name
customer_portal_urltext- Where the customer manages it (works for 24 hours)
ends_attext- When a cancelled one ends (ISO 8601)
idtext- The subscription's ID
order_idtext- The order that started it
pause_modetext- void (keep access, no charge) or free; empty if not paused
pausedtrue/false- True when payments are paused
product_idtext- The product's ID
product_nametext- The product
renews_attext- When it next renews (ISO 8601)
resumes_attext- When a pause ends (ISO 8601); empty if not set
statustext- on_trial, active, paused, past_due, unpaid, cancelled or expired
test_modetrue/false- True for a test-mode subscription
trial_ends_attext- When a trial ends (ISO 8601)
update_payment_urltext- Where the customer updates their card (works for 24 hours)
variant_idtext- The price's ID
variant_nametext- The price, such as Monthly
Example output
{
"cancelled": false,
"card_brand": "visa",
"card_last_four": "4242",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"customer_portal_url": "https://example.lemonsqueezy.com/billing?expires=1",
"ends_at": "",
"id": "301",
"order_id": "1001",
"pause_mode": "",
"paused": false,
"product_id": "10",
"product_name": "Pro plan",
"renews_at": "2027-10-27T10:00:00.000000Z",
"resumes_at": "",
"status": "active",
"test_mode": false,
"trial_ends_at": "",
"update_payment_url": "https://example.lemonsqueezy.com/subscription/301/payment-details",
"variant_id": "11",
"variant_name": "Yearly"
}Check license key
Check whether a license key is valid, and whose it is, as your app would.
Inputs
- License key
keytextRequired - The full license key.
Outputs
activation_limitnumber- How many devices it may be used on
activationsnumber- How many devices it is used on
customer_emailtext- The buyer's email address
errortext- Why it isn't valid; empty when it is
expires_attext- When it expires (ISO 8601); empty if never
product_nametext- The product it is for
statustext- inactive, active, expired or disabled
store_idtext- The store that sold it
validtrue/false- True when the key is valid
Example output
{
"activation_limit": 3,
"activations": 1,
"customer_email": "sam@example.com",
"error": "",
"expires_at": "",
"product_name": "Pro plan",
"status": "active",
"store_id": "1",
"valid": true
}Create checkout link
Make a checkout link for a product, with the buyer's details and a discount filled in.
Inputs
- Store
storetextRequired - The store selling it.
- Product price
varianttextRequired - The product and price to sell.
- Buyer's email
emailtext - Fill in the buyer's email address.
- Buyer's name
nametext - Fill in the buyer's name.
- Discount code
discount_codetext - Apply this discount code.
- Custom price
custom_pricenumber - Charge this instead of the usual price, in the store's currency, such as 49.00.At least 0.01.
- After paying, go to
redirect_urltext - Send the buyer to this address after they pay.
- Link expires
expires_atdate and time - When the link stops working. Leave empty for never.
- Custom data
custom_dataobject - Fields to keep with the order, such as your own user ID; webhooks and orders carry them.
- Test mode
test_modetrue/false - Make it in test mode, where no real money moves. Off by default.Default:
false.
Outputs
expires_attext- When it stops working (ISO 8601); empty if never
idtext- The checkout's ID
test_modetrue/false- True for a test-mode checkout
urltext- The checkout link to send the buyer
variant_idtext- The price it sells
Example output
{
"expires_at": "",
"id": "5e8b546c-c561-4a2c-a586-40c18bb2a195",
"test_mode": false,
"url": "https://example.lemonsqueezy.com/checkout/custom/5e8b546c-c561-4a2c-a586-40c18bb2a195?signature=abc",
"variant_id": "11"
}Create discount code
Create a discount code for a store, as a percent or an amount off.
Inputs
- Store
storetextRequired - The store it works in.
- Name
nametextRequired - What the discount is called, such as Spring sale.
- Code
codetextRequired - The code buyers enter: 3 or more capital letters and numbers, such as SPRING20.
- Discount type
amount_typetext - A percent or an amount off. Defaults to a percent.One of:
percent(Percent off),fixed(Amount off). Default:percent. - Amount
amountnumberRequired - The percent off (20), or the amount off in the store's currency (5.00).At least 0.01.
- For subscriptions, applies to
durationtext - Which payments of a subscription it takes off. Defaults to the first payment only.One of:
once(First payment only),repeating(A number of months),forever(Every payment). Default:once. - Months
monthsnumber - With 'A number of months', for how many months.At least 1.
- Can be used
max_redemptionsnumber - How many times it can be used in all. Leave empty for no limit.At least 1.
- Expires
expires_atdate and time - When it stops working. Leave empty for never.
- Test mode
test_modetrue/false - Make it in test mode, where no real money moves. Off by default.Default:
false.
Outputs
amountnumber- The percent, or the amount off in the store's currency
amount_typetext- percent or fixed
codetext- The code buyers enter
durationtext- once, repeating or forever
expires_attext- When it ends (ISO 8601)
idtext- The discount's ID
max_redemptionsnumber- How many times it can be used; 0 for no limit
nametext- Its name
starts_attext- When it starts (ISO 8601)
statustext- draft or published
test_modetrue/false- True when it works only in test mode
Example output
{
"amount": 20,
"amount_type": "percent",
"code": "SPRING20",
"duration": "once",
"expires_at": "2026-12-31T23:59:59.000000Z",
"id": "401",
"max_redemptions": 0,
"name": "Spring sale",
"starts_at": "",
"status": "published",
"test_mode": false
}Delete discount code
Delete a discount code, so it can no longer be used.
Inputs
- Discount code
discounttextRequired - The discount's ID, from 'Create discount code' or 'List discount codes'.
Outputs
deletedtrue/false- True once deleted
idtext- The deleted discount's ID
Example output
{
"deleted": true,
"id": "401"
}Find customers
Find customers by store or email, with what they have spent.
Inputs
- Store
storetext - Only this store's customers.
- Customer email
emailtext - Only for this customer's email address.
- How many
limitnumber - How many customers, newest first. Defaults to 25.From 1 to 500.
Outputs
countnumber- How many were returned
customerslist- The customers
totalnumber- How many match in all
Example output
{
"count": 1,
"customers": [
{
"country": "US",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_portal_url": "https://example.lemonsqueezy.com/billing",
"email": "sam@example.com",
"id": "201",
"monthly_revenue": 8.25,
"name": "Sam Lee",
"status": "subscribed",
"total_revenue": 99.0
}
],
"total": 1
}Find license keys
Find the license keys sold by a store, with an order or for a product.
Inputs
- Store
storetext - Only this store's license keys.
- Order
ordertext - Only the keys sold with this order.
- Product
producttext - Only for this product.
- How many
limitnumber - How many license keys, newest first. Defaults to 25.From 1 to 500.
Outputs
countnumber- How many were returned
license_keyslist- The license keys
totalnumber- How many match in all
Example output
{
"count": 1,
"license_keys": [
{
"activation_limit": 3,
"activations": 1,
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"expires_at": "",
"id": "501",
"key": "38b1460a-5104-4067-a91d-77b872934d51",
"key_short": "XXXX-77b872934d51",
"order_id": "1001",
"product_id": "10",
"status": "active"
}
],
"total": 1
}Get order
Get one order: who bought what, what they paid and their receipt.
Inputs
- Order
ordertextRequired - The order's ID, from 'List orders' or the 'New order' trigger.
Outputs
created_attext- When it was placed (ISO 8601)
currencytext- The currency, such as USD
customer_emailtext- The buyer's email address
customer_idtext- The buyer's customer ID
customer_nametext- The buyer's name
idtext- The order's ID
order_numbernumber- Its number in the store
product_idtext- The product's ID
product_nametext- The product bought
receipt_urltext- The buyer's receipt
refundedtrue/false- True when refunded
refunded_amountnumber- How much was refunded
statustext- pending, failed, paid, refunded, partial_refund or fraudulent
test_modetrue/false- True for a test-mode order
totalnumber- What they paid, in the store's currency
total_formattedtext- What they paid, as shown, such as $11.99
variant_idtext- The price's ID
variant_nametext- The price bought
Example output
{
"created_at": "2026-10-27T10:00:00.000000Z",
"currency": "USD",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"id": "1001",
"order_number": 42,
"product_id": "10",
"product_name": "Pro plan",
"receipt_url": "https://app.lemonsqueezy.com/my-orders/abc/receipt",
"refunded": false,
"refunded_amount": 0.0,
"status": "paid",
"test_mode": false,
"total": 99.0,
"total_formatted": "$99.00",
"variant_id": "11",
"variant_name": "Yearly"
}Get subscription
Get one subscription, with links the customer can use to manage it or update their card.
Inputs
- Subscription
subscriptiontextRequired - The subscription's ID, from 'List subscriptions' or the 'New subscription' trigger.
Outputs
cancelledtrue/false- True when it ends at the period's end
card_brandtext- The card's brand, such as visa
card_last_fourtext- The card's last four digits
created_attext- When it started (ISO 8601)
customer_emailtext- The customer's email address
customer_idtext- The customer's ID
customer_nametext- The customer's name
customer_portal_urltext- Where the customer manages it (works for 24 hours)
ends_attext- When a cancelled one ends (ISO 8601)
idtext- The subscription's ID
order_idtext- The order that started it
pause_modetext- void (keep access, no charge) or free; empty if not paused
pausedtrue/false- True when payments are paused
product_idtext- The product's ID
product_nametext- The product
renews_attext- When it next renews (ISO 8601)
resumes_attext- When a pause ends (ISO 8601); empty if not set
statustext- on_trial, active, paused, past_due, unpaid, cancelled or expired
test_modetrue/false- True for a test-mode subscription
trial_ends_attext- When a trial ends (ISO 8601)
update_payment_urltext- Where the customer updates their card (works for 24 hours)
variant_idtext- The price's ID
variant_nametext- The price, such as Monthly
Example output
{
"cancelled": false,
"card_brand": "visa",
"card_last_four": "4242",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"customer_portal_url": "https://example.lemonsqueezy.com/billing?expires=1",
"ends_at": "",
"id": "301",
"order_id": "1001",
"pause_mode": "",
"paused": false,
"product_id": "10",
"product_name": "Pro plan",
"renews_at": "2027-10-27T10:00:00.000000Z",
"resumes_at": "",
"status": "active",
"test_mode": false,
"trial_ends_at": "",
"update_payment_url": "https://example.lemonsqueezy.com/subscription/301/payment-details",
"variant_id": "11",
"variant_name": "Yearly"
}List discount codes
List a store's discount codes.
Inputs
- Store
storetext - Only this store's discount codes.
- How many
limitnumber - How many discount codes, newest first. Defaults to 25.From 1 to 500.
Outputs
countnumber- How many were returned
discountslist- The discount codes
totalnumber- How many match in all
Example output
{
"count": 1,
"discounts": [
{
"amount": 20,
"amount_type": "percent",
"code": "SPRING20",
"duration": "once",
"expires_at": "2026-12-31T23:59:59.000000Z",
"id": "401",
"max_redemptions": 0,
"name": "Spring sale",
"starts_at": "",
"status": "published",
"test_mode": false
}
],
"total": 1
}List orders
List orders, newest first, for a store or a buyer's email.
Inputs
- Store
storetext - Only this store's orders.
- Customer email
emailtext - Only for this customer's email address.
- How many
limitnumber - How many orders, newest first. Defaults to 25.From 1 to 500.
Outputs
countnumber- How many were returned
orderslist- The orders, newest first
totalnumber- How many match in all
Example output
{
"count": 1,
"orders": [
{
"created_at": "2026-10-27T10:00:00.000000Z",
"currency": "USD",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"id": "1001",
"order_number": 42,
"product_id": "10",
"product_name": "Pro plan",
"receipt_url": "https://app.lemonsqueezy.com/my-orders/abc/receipt",
"refunded": false,
"refunded_amount": 0.0,
"status": "paid",
"test_mode": false,
"total": 99.0,
"total_formatted": "$99.00",
"variant_id": "11",
"variant_name": "Yearly"
}
],
"total": 1
}List products
List a store's products, each with its prices.
Inputs
- Store
storetext - Only this store's products.
Outputs
countnumber- How many were returned
productslist- The products
Example output
{
"count": 1,
"products": [
{
"buy_now_url": "https://example.lemonsqueezy.com/checkout/buy/abc",
"id": "10",
"name": "Pro plan",
"price": "$9.00",
"status": "published",
"store_id": "1",
"variants": [
{
"id": "11",
"interval": "year",
"is_subscription": true,
"name": "Yearly",
"price": 99.0,
"status": "published"
}
]
}
]
}List stores
List the account's stores with their sales.
Inputs
None.
Outputs
countnumber- How many were returned
storeslist- The stores
Example output
{
"count": 1,
"stores": [
{
"currency": "USD",
"domain": "example.lemonsqueezy.com",
"id": "1",
"name": "Example Software",
"slug": "example",
"total_revenue": 4158.0,
"total_sales": 42,
"url": "https://example.lemonsqueezy.com"
}
]
}List subscriptions
List subscriptions by store, status, customer email or product.
Inputs
- Store
storetext - Only this store's subscriptions.
- Status
statustext - Only subscriptions in this state. Defaults to any.One of:
any(Any status),on_trial(On trial),active,paused,past_due(Past due (a payment failed)),unpaid,cancelled(Cancelled (ends at the period's end)),expired. Default:any. - Customer email
emailtext - Only for this customer's email address.
- Product
producttext - Only for this product.
- How many
limitnumber - How many subscriptions, newest first. Defaults to 25.From 1 to 500.
Outputs
countnumber- How many were returned
subscriptionslist- The subscriptions
totalnumber- How many match in all
Example output
{
"count": 1,
"subscriptions": [
{
"cancelled": false,
"card_brand": "visa",
"card_last_four": "4242",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"customer_portal_url": "https://example.lemonsqueezy.com/billing?expires=1",
"ends_at": "",
"id": "301",
"order_id": "1001",
"pause_mode": "",
"paused": false,
"product_id": "10",
"product_name": "Pro plan",
"renews_at": "2027-10-27T10:00:00.000000Z",
"resumes_at": "",
"status": "active",
"test_mode": false,
"trial_ends_at": "",
"update_payment_url": "https://example.lemonsqueezy.com/subscription/301/payment-details",
"variant_id": "11",
"variant_name": "Yearly"
}
],
"total": 1
}Pause subscription
Stop charging a subscription for now, until a date or until it is resumed.
Inputs
- Subscription
subscriptiontextRequired - The subscription's ID, from 'List subscriptions' or the 'New subscription' trigger.
- While paused
modetext - Keep access without charging, or give access for free. Defaults to keeping access without charging.One of:
void(Keep access, don't charge),free(Give access for free). Default:void. - Resume on
resume_atdate and time - When to start charging again. Leave empty to pause until resumed.
Outputs
cancelledtrue/false- True when it ends at the period's end
card_brandtext- The card's brand, such as visa
card_last_fourtext- The card's last four digits
created_attext- When it started (ISO 8601)
customer_emailtext- The customer's email address
customer_idtext- The customer's ID
customer_nametext- The customer's name
customer_portal_urltext- Where the customer manages it (works for 24 hours)
ends_attext- When a cancelled one ends (ISO 8601)
idtext- The subscription's ID
order_idtext- The order that started it
pause_modetext- void (keep access, no charge) or free; empty if not paused
pausedtrue/false- True when payments are paused
product_idtext- The product's ID
product_nametext- The product
renews_attext- When it next renews (ISO 8601)
resumes_attext- When a pause ends (ISO 8601); empty if not set
statustext- on_trial, active, paused, past_due, unpaid, cancelled or expired
test_modetrue/false- True for a test-mode subscription
trial_ends_attext- When a trial ends (ISO 8601)
update_payment_urltext- Where the customer updates their card (works for 24 hours)
variant_idtext- The price's ID
variant_nametext- The price, such as Monthly
Example output
{
"cancelled": false,
"card_brand": "visa",
"card_last_four": "4242",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"customer_portal_url": "https://example.lemonsqueezy.com/billing?expires=1",
"ends_at": "",
"id": "301",
"order_id": "1001",
"pause_mode": "void",
"paused": true,
"product_id": "10",
"product_name": "Pro plan",
"renews_at": "2027-10-27T10:00:00.000000Z",
"resumes_at": "",
"status": "paused",
"test_mode": false,
"trial_ends_at": "",
"update_payment_url": "https://example.lemonsqueezy.com/subscription/301/payment-details",
"variant_id": "11",
"variant_name": "Yearly"
}Refund order
Refund an order in full, or part of it. It cannot be undone.
Inputs
- Order
ordertextRequired - The order's ID, from 'List orders' or the 'New order' trigger.
- Amount
amountnumber - How much to refund, in the store's currency. Leave empty to refund it all.At least 0.01.
Outputs
created_attext- When it was placed (ISO 8601)
currencytext- The currency, such as USD
customer_emailtext- The buyer's email address
customer_idtext- The buyer's customer ID
customer_nametext- The buyer's name
idtext- The order's ID
order_numbernumber- Its number in the store
product_idtext- The product's ID
product_nametext- The product bought
receipt_urltext- The buyer's receipt
refundedtrue/false- True when refunded
refunded_amountnumber- How much was refunded
statustext- pending, failed, paid, refunded, partial_refund or fraudulent
test_modetrue/false- True for a test-mode order
totalnumber- What they paid, in the store's currency
total_formattedtext- What they paid, as shown, such as $11.99
variant_idtext- The price's ID
variant_nametext- The price bought
Example output
{
"created_at": "2026-10-27T10:00:00.000000Z",
"currency": "USD",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"id": "1001",
"order_number": 42,
"product_id": "10",
"product_name": "Pro plan",
"receipt_url": "https://app.lemonsqueezy.com/my-orders/abc/receipt",
"refunded": true,
"refunded_amount": 99.0,
"status": "refunded",
"test_mode": false,
"total": 99.0,
"total_formatted": "$99.00",
"variant_id": "11",
"variant_name": "Yearly"
}Resume subscription
Start charging a paused subscription again, or keep a cancelled one from ending.
Inputs
- Subscription
subscriptiontextRequired - The subscription's ID, from 'List subscriptions' or the 'New subscription' trigger.
Outputs
cancelledtrue/false- True when it ends at the period's end
card_brandtext- The card's brand, such as visa
card_last_fourtext- The card's last four digits
created_attext- When it started (ISO 8601)
customer_emailtext- The customer's email address
customer_idtext- The customer's ID
customer_nametext- The customer's name
customer_portal_urltext- Where the customer manages it (works for 24 hours)
ends_attext- When a cancelled one ends (ISO 8601)
idtext- The subscription's ID
order_idtext- The order that started it
pause_modetext- void (keep access, no charge) or free; empty if not paused
pausedtrue/false- True when payments are paused
product_idtext- The product's ID
product_nametext- The product
renews_attext- When it next renews (ISO 8601)
resumes_attext- When a pause ends (ISO 8601); empty if not set
statustext- on_trial, active, paused, past_due, unpaid, cancelled or expired
test_modetrue/false- True for a test-mode subscription
trial_ends_attext- When a trial ends (ISO 8601)
update_payment_urltext- Where the customer updates their card (works for 24 hours)
variant_idtext- The price's ID
variant_nametext- The price, such as Monthly
Example output
{
"cancelled": false,
"card_brand": "visa",
"card_last_four": "4242",
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"customer_id": "201",
"customer_name": "Sam Lee",
"customer_portal_url": "https://example.lemonsqueezy.com/billing?expires=1",
"ends_at": "",
"id": "301",
"order_id": "1001",
"pause_mode": "",
"paused": false,
"product_id": "10",
"product_name": "Pro plan",
"renews_at": "2027-10-27T10:00:00.000000Z",
"resumes_at": "",
"status": "active",
"test_mode": false,
"trial_ends_at": "",
"update_payment_url": "https://example.lemonsqueezy.com/subscription/301/payment-details",
"variant_id": "11",
"variant_name": "Yearly"
}Update license key
Turn a license key off or on, or change how many devices or how long it works.
Inputs
- License key
license_keytextRequired - The license key's ID, from 'Find license keys'.
- Turned off
disabledtrue/false - On to stop the key working, off to let it work again.
- Devices allowed
activation_limitnumber - How many devices it may be used on. Leave empty to keep it.At least 1.
- Expires
expires_atdate and time - When it stops working. Leave empty to keep it.
Outputs
activation_limitnumber- How many devices it may be used on; empty for no limit
activationsnumber- How many devices it is used on
created_attext- When it was made (ISO 8601)
customer_emailtext- The buyer's email address
expires_attext- When it expires (ISO 8601); empty if never
idtext- The license key's ID
keytext- The full key
key_shorttext- Its last characters, such as XXXX-8A9B1C2D3E4F
order_idtext- The order it came with
product_idtext- The product it is for
statustext- inactive, active, expired or disabled
Example output
{
"activation_limit": 3,
"activations": 1,
"created_at": "2026-10-27T10:00:00.000000Z",
"customer_email": "sam@example.com",
"expires_at": "",
"id": "501",
"key": "38b1460a-5104-4067-a91d-77b872934d51",
"key_short": "XXXX-77b872934d51",
"order_id": "1001",
"product_id": "10",
"status": "active"
}