https://github.com/mrwyndham/pocketbase-lemonsqueezy
A small repo to help SaaS devs build a LemonSqueezy integration with Pocketbase
https://github.com/mrwyndham/pocketbase-lemonsqueezy
lemonsqueezy pocketbase saas
Last synced: 6 days ago
JSON representation
A small repo to help SaaS devs build a LemonSqueezy integration with Pocketbase
- Host: GitHub
- URL: https://github.com/mrwyndham/pocketbase-lemonsqueezy
- Owner: mrwyndham
- Created: 2024-11-05T07:23:53.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-05T06:40:20.000Z (3 months ago)
- Last Synced: 2024-12-05T07:29:42.850Z (3 months ago)
- Topics: lemonsqueezy, pocketbase, saas
- Language: JavaScript
- Homepage: https://fastpocket.dev
- Size: 27.3 KB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-pocketbase - PocketBase+Lemonsqueezy - Go extended PocketBase for Lemonsqueezy subscription integration.  (Top PocketBase-specific Projects (>100 stars))
README
# PocketBase LemonSqueezy Integration
This is a PocketBase plugin that provides integration with the LemonSqueezy API for handling subscriptions, checkouts, and product synchronization. This is a front end agnostic hook that you can use 100% with any SaaS application. If there are any issues please feel free to reach out to me on X - @meinbiz
Also if you want to build a next.js front end for your next app. Consider fastpocket.dev it is the fastest way to build a fully fledged PocketBase app.
## Features
- Webhook handling for LemonSqueezy events (subscriptions created, cancelled, payments)
- Customer portal integration
- Checkout session creation
- Automatic product/variant/subscription synchronization via cron job
- Manual synchronization endpoint
- Customer management and linking with PocketBase users
## Prerequisites
Before using this code, ensure you have:
1. A LemonSqueezy account with API access
2. PocketBase installed and running
3. The following collections schema imported (create `pb_schema.json`):
- customer
- subscription
- product
- variant
**Note:** If you are using a version of PocketBase earlier than 23, you need to use the `-legacy` files for compatibility.
## Setup
### 1. PocketBase Configuration
First, you'll need to set up PocketBase hooks. Follow these steps:
1. Create a new JavaScript file (e.g., `pb_hooks/main.pb.js`)
2. Copy the provided code into this file
3. Restart your PocketBase server to load the hooks
For more details on setting up PocketBase hooks, refer to the [official PocketBase Hooks documentation](https://pocketbase.io/docs/js-overview/).
### 2. LemonSqueezy Configuration
1. Replace the webhook signing secret:
```javascript
const secret = "your_lemonsqueezy_signing_secret_here";
```
2. Replace the API key in all relevant functions:
```javascript
const apiKey = "your_api_key_here";
```
3. Update your store ID in the `/create-checkout-session` endpoint:
```javascript
"id": "your_store_id" // Update this in the store relationship object
```
## Available Endpoints
### Webhooks
- `POST /lemonsqueezy` - Handles LemonSqueezy webhook events
- Processes subscription events (created, cancelled, payment success)
- Automatically updates local database records
### Customer Management
- `POST /create-checkout-session` - Creates a new checkout session
- Requires authenticated user
- Automatically creates/links LemonSqueezy customer
- Returns checkout URL
- `POST /create-portal-link` - Generates customer portal link
- Requires authenticated user
- Returns URL to LemonSqueezy customer portal
### Synchronization
- `GET /manual-lemonsqueezy-synchronization` - Manually trigger sync
- Syncs products, variants, and subscriptions
- Updates local database records
## Automatic Synchronization
The plugin includes a cron job that runs every 30 minutes to sync data:
The cron job automatically:
- Fetches all subscriptions from LemonSqueezy
- Updates existing subscription records in PocketBase
- Creates new subscription records if they don't exist
- Syncs product and variant data
- Maintains data consistency between LemonSqueezy and PocketBase
### Postman Collection
To facilitate testing and integration, a Postman collection is included in the project. You can find it at `./pocketbase-lemonsqueezy.postman_collection.json`. This collection contains pre-configured requests for all available endpoints, allowing you to quickly test the API functionality and understand the request/response flow.
## Video Documentation
If you are struggling - I have setup a [video tutorial](https://www.youtube.com/watch?v=LRQS6PRzvVo) check it out