Skip to content

README.md

Latest commit

 

History

History
114 lines (77 loc) · 6.43 KB

README.md

File metadata and controls

114 lines (77 loc) · 6.43 KB
Raw

💳 Node.js Lemon Squeezy Subscriptions Function

Receive recurring card payments and grant subscribers extra permissions.

🧰 Usage

POST /subscribe

This endpoint initiates a Lemon Squeezy checkout for a subscription. The user ID is fetched from the headers of the request. If the user ID is not found or a Lemon Squeezy checkout could not be created, the request will be redirected to a cancel URL.

Parameters

Name Description Location Type Sample Value
x-appwrite-user-id User ID from Appwrite. Header String 642...7cd
Content-Type The content type of the request body Header application/json N/A
failureUrl The URL to redirect to after a cancelled payment attempt. Body String https://example.com/failure

Response

Sample 303 Response:

The response is a redirect to the Lemon Squeezy checkout URL or to the failure URL if an error occurs

Location: https://ap...re.lemonsqueezy.com/checkout/custom/7576abf3-...e2fb

Location: https://mywebapp.com/cancel

POST /webhook

This endpoint is a webhook that handles two types of events from Lemon Squeezy: subscription_created and subscription_expired. It validates the incoming request using the X-Signature header from the Lemon Squeezy webhook. If the validation fails, a 401 response is sent.

Parameters

Name Description Location Type Sample Value
None Webhook payload from Lemon Squeezy. Body Object [See Lemon Squeezy documentation](https://Lemon Squeezy.com/docs/api/events/object)
x-signature Signature from Lemon Squeezy. Headers String See Lemon Squeezy docs
x-event-name Name of Lemon Squeezy webhook event Headers String See Lemon Squeezy docs

Response

Sample 200 Response:

In case of subscription_created event, it gives user subscriber label. In case of subscription_expired event, it takes subscriber label away from user.

{ "success": true }

Sample 401 Response:

{ "success": false }

⚙️ Configuration

Setting Value
Runtime Node (18.0)
Entrypoint src/main.js
Build Commands npm install
Permissions any
Timeout (Seconds) 15

If using a demo web app to subscribe, make sure to add your function domain as a web platform to your Appwrite project. Doing this fixes CORS errors and allows proper functionality.

🔒 Environment Variables

LEMON_SQUEEZY_API_KEY

API key for sending requests to the Lemon Squeezy API.

Question Answer
Required Yes
Sample Value eyJ0eXAiOiJ...
Documentation Lemon Squeezy: API Keys

LEMON_SQUEEZY_WEBHOOK_SECRET

Secret used to validate the Lemon Squuezy Webhook signature.

Question Answer
Required Yes
Sample Value abcd...
Documentation Lemon Squeezy: Webhooks

LEMON_SQUEEZY_STORE_ID

Store ID required to create a checkout using the Lemon Squeezy API.

Question Answer
Required Yes
Sample Value 123456
Documentation Lemon Squeezy: Checkouts

LEMON_SQUEEZY_VARIANT_ID

Variant ID of a product required to create a checkout using the Lemon Squeezy API.

Question Answer
Required Yes
Sample Value 123456
Documentation Lemon Squeezy: Checkouts