Receive recurring card payments and grant subscribers extra permissions.
This endpoint initiates a Stripe checkout session for a subscription. The user ID is fetched from the headers of the request. If the user ID is not found or a Stripe checkout session 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 |
| successUrl | The URL to redirect to after a successful payment. | Body | String | https://example.com/success |
| 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 Stripe checkout session URL or to the cancel URL if an error occurs
Location: https://checkout.stripe.com/pay/cs_test_...#fidkdWxOYHwnP
Location: https://mywebapp.com/cancel
This endpoint is a webhook that handles two types of events from Stripe: customer.subscription.created and customer.subscription.deleted. It validates the incoming request using the Stripe's validateWebhook method. If the validation fails, a 401 response is sent.
Parameters
| Name | Description | Location | Type | Sample Value |
|---|---|---|---|---|
| None | Webhook payload from Stripe. | Body | Object | See Stripe documentation |
Response
Sample 200 Response:
In case of customer.subscription.created event, it gives user subscriber label.
In case of customer.subscription.deleted event, it takes subscriber label away from user.
{ "success": true }Sample 401 Response:
{ "success": false }| 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.
Your Appwrite project's API key.
| Question | Answer |
|---|---|
| Required | Yes |
| Sample Value | 083d341ee48... |
| Documentation | Appwrite: Create an API key |
The endpoint where your Appwrite server is located. If not provided, it defaults to the Appwrite Cloud server: https://cloud.appwrite.io/v1.
| Question | Answer |
|---|---|
| Required | No |
| Sample Value | https://cloud.appwrite.io/v1 |
Secret for sending requests to the Stripe API.
| Question | Answer |
|---|---|
| Required | Yes |
| Sample Value | sk_test_51J... |
| Documentation | Stripe: API Keys |
Secret used to validate the Stripe Webhook signature.
| Question | Answer |
|---|---|
| Required | Yes |
| Sample Value | whsec_... |
| Documentation | Stripe: Webhooks |