nuxt-chargebee

Chargebee module for Nuxt.js that allows to checkout and open the self-service portal inside a Nuxt.js app.

Usage no npm install needed!

<script type="module">
  import nuxtChargebee from 'https://cdn.skypack.dev/nuxt-chargebee';
</script>

README

nuxt-chargebee

npm version Linux macOS Windows compatible Build status Coverage status Dependency status Renovate enabled
Open in Gitpod Buy Me a Coffee PayPal Patreon

Chargebee module for Nuxt.js that allows to checkout and open the self-service portal inside a Nuxt.js app.

Install

# npm
$ npm install nuxt-chargebee

# Yarn
$ yarn add nuxt-chargebee

Usage

Add the module to your Nuxt.js modules list in nuxt.config.js:

export default {
  ...
  modules: [
    ['nuxt-chargebee', { siteName: 'my-site' }],
  ],
}

Or use the top-level option:

export default {
  ...
  modules: [
    'nuxt-chargebee',
  ],
  chargebee: {
    siteName: 'my-site',
  },
}

Then you can checkout in your components or open the self-service portal:

export default {
  props: {
    ...
  },
  methods: {
    checkout() {
      this.$chargebee.checkout('my-plan-id')
    },
    portal() {
      this.$chargebee.portal()
    },
  },
}

User Sessions

It is possible to configure a session url. This url is used to create a session for checkout and the self-service portal:

export default {
  ...
  modules: [
    ['nuxt-chargebee', { siteName: 'my-site', sessionUrl: '/api/create-session' }],
  ],
}

More information on portal sessions can be found in the Chargebee API docs.

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

Buy Me a Coffee  If you want to send me a one time donation. The coffee is pretty good 😊.
PayPal  Also for one time donations if you like PayPal.
Patreon  Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

License

MIT License © Sebastian Landwehr