Stripe
Introduction
Follow this guide to get set up with Stripe.
Create Stripe Account
- First, create a Stripe account (opens in a new tab) if you don't have one already. Follow the onboarding instructions to set up your Stripe account with your bank account and fill in other details.
Getting the API Key
- Next, you will need to get the Stripe API key from the API keys page (opens in a new tab). Here you will find the Publishable key and the Secret key. If you don't see any, click "+ Create secret key" to create a new key.
- In the
.env.local
file of your project, add the secret key to theSTRIPE_API_KEY
variable.
Creating Products
- For your user to choose between different products or subscription plans, you will need to create a Product first on the Products page (opens in a new tab). Click "+ Add product" to create a Product per subscription plan or product you want to offer. For our example, we will be creating two Products.
Getting the Pricing IDs
- We will need to get the Pricing ID of each Product. Go into the page of each Product. Under the Pricing section, there will be a Price. Click on the Price to go to its Price page.
- At the top right of the page, there is a Pricing ID that looks something like price_xxxxx. Copy & paste that pricing ID to
STRIPE_PRICE_ID_1
in the.env.local
file of your project. - Repeat the same process for the second Product and copy & paste the pricing ID to
STRIPE_PRICE_ID_2
in the.env.local
file of your project.
Creating a Webhook
- To update the current subscription status of a user and other information in your database, you will need to set up a Stripe webhook. First, go to the Webhooks page (opens in a new tab) and click "+ Add endpoint".
- Next, fill in the details to create the webhook endpoint.
- For Endpoint URL, be sure to add
/api/webhook
to the end of your website name.- for example: https://www.myapp.com/api/webhook (opens in a new tab)
- If you are using localhost, you can use a tunneling tool like Tunnelmole (opens in a new tab) or ngrok (opens in a new tab) to expose your local server to the internet. Just be sure to add
/api/webhook
at the end of your tunneled URL.
- For Listen to, choose
Events on your account
. - For Select events to listen to, choose the following events:
checkout.session.completed
invoice.payment_succeeded
- For Endpoint URL, be sure to add
- After creating the endpoint, on the endpoint's page, click Reveal under Signing secret. Copy this signing secret, go to the
.env.local
file of your project, and paste it inSTRIPE_WEBHOOK_SIGNING_SECRET
. - If you are in test mode, you can try purchasing the product or subscription plan with a test payment method (opens in a new tab). In the webhook page, you will then be able to see whether the webhook was configured successfully by clicking on View logs under the Configuration section.
Next Steps
🚀 Congratulations, you've successfully set up payments! Proceed to the Deployment page to continue with setup.