Developer guide

Customer Portal

The Customer Portal is a no-code solution that lets your customers easily self-manage their subscriptions from your store.

This means you can add a simple button or link to your application instead of building a full billing section.

Note: The Customer Portal is a drop-in UI but you will still need to set up webhooks if you want your billing and application data to stay in sync.

For more details about the available features, read the Customer Portal docs.

Add Customer Portal to your app

You can add the Customer Portal to your application simply by linking to it, allowing customers to start managing their subscriptions and billing information with a single click.

Subscription and Customer objects contain a signed customer_portal URL in the urls object. This URL will automatically log in customers to manage their subscription(s) and is valid for 24 hours. In cases where customers do not possess any subscription, the customer_portal property will be set to null.

{ ... "cancelled": false, "trial_ends_at": null, "billing_anchor": 30, "urls": { "update_payment_method": "", "customer_portal": "" }, "renews_at": "2023-07-30T11:48:33.000000Z", "ends_at": null, ... }

Note: If you have a custom domain set up, all Customer Portal and update payment method URLs use your custom domain.

We recommend you request a new URL (by calling the Retrieve a subscription endpoint or Retrieve a customer endpoint) when a user clicks a Billing button in your app, then redirect them to the URL in the response.

// index.js app.get('/api/subscriptions', (req, res) => { // Using @lemonsqueezy/lemonsqueezy.js const response = await ls.getSubscription({ id: req.session.subscriptionId }) res.json({ url: response['data']['attributes']['urls']['customer_portal'] }) })

If you don't want to make an API call when a customer clicks through to the Customer Portal you can use the unsigned URL:


Note that with this option, if your customer is not already logged into their Lemon Squeezy account, they will see a form to log in via an email magic link like My Orders.

Customising the Customer Portal

In the Design settings in your dashboard, you have some options to customise your Customer Portal. Any changes you make here will be shown to all customers.

You can change the copy shown at the top of the page and can easily toggle different parts of the portal.

You can even select which subscription products/variants your customers are allowed to upgrade and downgrade to.

Make sure to add a URL in the "Back" link option so your customers can easily get back to your application.

Taking payments