https://github.com/ynnoj/next-stripe
Simplified server-side Stripe workflows in Next.js
https://github.com/ynnoj/next-stripe
nextjs stripe
Last synced: about 1 month ago
JSON representation
Simplified server-side Stripe workflows in Next.js
- Host: GitHub
- URL: https://github.com/ynnoj/next-stripe
- Owner: ynnoj
- License: mit
- Created: 2021-01-26T14:58:02.000Z (over 4 years ago)
- Default Branch: beta
- Last Pushed: 2025-04-30T16:12:16.000Z (about 2 months ago)
- Last Synced: 2025-04-30T17:27:14.865Z (about 2 months ago)
- Topics: nextjs, stripe
- Language: JavaScript
- Homepage:
- Size: 128 KB
- Stars: 566
- Watchers: 9
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NextStripe
Simplified server-side Stripe workflows in Next.js
> ⚠️ PLEASE NOTE: This library is currently in beta and should be used in production with caution!
## Getting Started
```
yarn add next-stripe@beta
```
### Add the API route
Create a `[...nextstripe].js` catch-all route in your project's `pages/api/stripe` directory.
> ⚠️ PLEASE NOTE: It is recommended you use a [restricted key](https://stripe.com/docs/keys#limit-access) with limited API access with this library. These keys can be created and configured with the required access in the Stripe Dashboard.
```js
import NextStripe from 'next-stripe'
export default NextStripe({
stripe_key: process.env.STRIPE_RESTRICTED_KEY
})
```
## Usage
`next-stripe/client` exports helper functions to call the Next.js API routes.
### Checkout Sessions
#### Create
[Stripe API Docs](https://stripe.com/docs/api/checkout/sessions/create)
```js
import { createCheckoutSession } from 'next-stripe/client'
const session = await createCheckoutSession({
success_url: window.location.href,
cancel_url: window.location.href,
line_items: [{ price: 'price_id', quantity: 1 }],
payment_method_types: ['card'],
mode: 'payment'
})
```
### PaymentIntents
#### Create
[Stripe API Docs](https://stripe.com/docs/api/payment_intents/create)
```js
import { createPaymentIntent } from 'next-stripe/client'
const paymentIntent = await createPaymentIntent({
amount: 1000,
currency: 'usd'
})
```
#### Confirm
[Stripe API Docs](https://stripe.com/docs/api/payment_intents/confirm)
```js
import { confirmPaymentIntent } from 'next-stripe/client'
const paymentIntent = await confirmPaymentIntent('pi_id', {
payment_method: 'pm_id'
})
```
#### Retrieve
[Stripe API Docs](https://stripe.com/docs/api/payment_intents/retrieve)
```js
import { retrievePaymentIntent } from 'next-stripe/client'
const paymentIntent = await retrievePaymentIntent('pi_id')
```
#### Update
[Stripe API Docs](https://stripe.com/docs/api/payment_intents/update)
```js
import { updatePaymentIntent } from 'next-stripe/client'
const paymentIntent = await updatePaymentIntent('pi_id', {
amount: 1000,
currency: 'usd'
})
```
### Billing Portal Sessions
#### Create
[Stripe API Docs](https://stripe.com/docs/api/customer_portal/create)
```js
import { createBillingPortalSession } from 'next-stripe/client'
const session = await createBillingPortalSession({
customer: 'cus_id',
return_url: window.location.href
})
```
## Acknowledgements
- A lot of the patterns in this library were inspired by [NextAuth](https://github.com/nextauthjs/next-auth).
- Thanks to [Jamie Barton](https://github.com/notrab/next-stripe) for the initial idea.