Lemon Squeezy

Get API keys

After you have created your account and a store for Lemon Squeezy, you will need to create a new API key. You can do this by going to the API page in the settings and clicking on the plus button. You will need to give your API key a name and then click on the Create button. Once you have created your API key, you will need to copy the API key to use it in the setup of the integration.

For local development, make sure to use Test Mode to not mess with the real transactions.

Set environment variables

You need to set the following environment variables:

LEMONSQUEEZY_API_KEY="" # Your Lemon Squeezy API key
LEMONSQUEEZY_SIGNING_SECRET="" # Your Lemon Squeezy webhook signing secret
LEMONSQUEEZY_STORE_ID="" # Your Lemon Squeezy store ID (can be found under Settings > Stores next to your store url, e.g #12345)

Please do not add the secret keys to the .env file in production. During development, you can place them in .env.local as it's not committed to the repository. In production, you can set them in the environment variables of your hosting provider.

Create products

For your users to choose from the available subscription plans, you need to create those Products first on the Products page. You can create as many products as you want.

Create one product per plan you want to offer. You can add multiple variant within the product to offer multiple models or different billing intervals.

To offer multiple intervals for each plan, you can use the Variant feature of Lemon Squeezy. Just create one variant for each interval/model you want to offer.

Create a webhook

To sync the current subscription status or checkout conclusion and other information to your database, you need to set up a webhook.

The webhook handling code comes ready to use with TurboStarter, you just have to create the webhook in the Lemon Squeezy dashboard and insert the URL for your project.

To configure a new webhook, go to the Webhooks page in the Lemon Squeezy settings and click the Plus button.

Select the following events:

• For subscriptions:
  • subscription_created
  • subscription_updated
  • subscription_cancelled
• For one-off payments:
  • order_created

You will also have to enter a Signing secret which you can get by running the following command in your terminal:

openssl rand -base64 32

Copy the generated string and paste it into the Signing secret field.

You also need to add this secret to your environment variables:

LEMONSQUEEZY_WEBHOOK_SECRET=your-signing-secret

To get the callback URL for the webhook, you can either use a local development URL or the URL of your deployed app:

Local development

If you want to test the webhook locally, you can use ngrok to create a tunnel to your local machine. Ngrok will then give you a URL that you can use to test the webhook locally.

To do so, install ngrok and run it with the following command (while your TurboStarter web development server is running):

ngrok http 3000

This will give you a URL (see the Forwarding output) that you can use to create a webhook in Lemon Squeezy. Just use that url and add /api/webhooks/billing to it.

Production deployment

When going to production, you will need to set the webhook URL and the events you want to listen to in Lemon Squeezy.

The webhook path is /api/webhooks/billing. If your app is hosted at https://myapp.com then you need to enter https://myapp.com/api/webhooks/billing as the URL.

All the relevant events are automatically handled by TurboStarter, so you don't need to do anything else. If you want to handle more events please check Webhooks for more information.