https://github.com/wefixers/nuxt-stripe

Nuxt module for Stripe, with local webhook testing support out of the box.
https://github.com/wefixers/nuxt-stripe

nuxt stripe stripe-webhook webhook

Last synced: about 2 months ago
JSON representation

Nuxt module for Stripe, with local webhook testing support out of the box.

• Host: GitHub
• URL: https://github.com/wefixers/nuxt-stripe
• Owner: wefixers
• License: mit
• Created: 2023-07-04T19:02:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T06:36:03.000Z (2 months ago)
• Last Synced: 2024-09-21T11:35:05.730Z (2 months ago)
• Topics: nuxt, stripe, stripe-webhook, webhook
• Language: Vue
• Homepage: https://nuxt-stripe.fixers.dev
• Size: 390 KB
• Stars: 7
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![nuxt-stripe-social-card](./docs/public/social-card.png)](https://nuxt-stripe.fixers.dev)

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![License][license-src]][license-href]

[![Nuxt][nuxt-src]][nuxt-href]

# Nuxt Stripe

A Nuxt module for Stripe, with local webhook testing support out of the box.

- [📖  Read Documentation](https://nuxt-stripe.fixers.dev)

- [✨  Release Notes](/CHANGELOG.md)

## Features

- ⛰  Use Stripe with Nuxt

- ⛰  Support local webhook testing out of the box.

- ⛰  Nuxt Devtools support to explore webhook events.

### Contributing

- Clone this repository

- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`

- Install dependencies using `pnpm install`

- Run `pnpm dev:prepare` to generate type stubs.

- Use `pnpm dev` to start [playground](./playground) in development mode.

## 📑 License

The classy [MIT License](./LICENSE)

[npm-version-src]: https://img.shields.io/npm/v/@fixers/nuxt-stripe/latest.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-version-href]: https://npmjs.com/package/@fixers/nuxt-stripe

[npm-downloads-src]: https://img.shields.io/npm/dm/@fixers/nuxt-stripe.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-downloads-href]: https://npmjs.com/package/@fixers/nuxt-stripe

[license-src]: https://img.shields.io/npm/l/@fixers/nuxt-stripe.svg?style=flat&colorA=18181B&colorB=28CF8D

[license-href]: https://npmjs.com/package/@fixers/nuxt-stripe

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js

[nuxt-href]: https://nuxt.com

# Version 4 Update Notice

Version 4 is an upcoming major update that will introduces breaking changes.

- Webhook handler has been refactored.

The helper `defineStripeWebhook` is now `stripeWebhookHandler`, the second parameter has been removed, the callback how accept as its first parameter the `StripeEvent` and as its second parameter the context object.

```ts

// The new callback signature

type StripeWebhookHandler = (

  event: Stripe.Event,

  context: {

    $event: H3Event

    stripe: Stripe

  }

)

=> any

```