https://github.com/dword-design/nuxt-chargebee
Chargebee module for Nuxt.js that allows to checkout and open the self-service portal inside a Nuxt.js app.
https://github.com/dword-design/nuxt-chargebee
bill billing merchant pay payment subscribe subscription
Last synced: 7 months ago
JSON representation
Chargebee module for Nuxt.js that allows to checkout and open the self-service portal inside a Nuxt.js app.
- Host: GitHub
- URL: https://github.com/dword-design/nuxt-chargebee
- Owner: dword-design
- License: other
- Created: 2020-09-19T12:19:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T15:55:47.000Z (7 months ago)
- Last Synced: 2025-03-11T16:40:17.638Z (7 months ago)
- Topics: bill, billing, merchant, pay, payment, subscribe, subscription
- Language: JavaScript
- Homepage:
- Size: 1.64 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# nuxt-chargebee
Chargebee module for Nuxt.js that allows to checkout and open the self-service portal inside a Nuxt.js app.
## Install
```bash
# npm
$ npm install nuxt-chargebee
# Yarn
$ yarn add nuxt-chargebee
```
## Usage
Add the module to your Nuxt.js modules list in `nuxt.config.js`:
```js
export default {
...
modules: [
['nuxt-chargebee', { siteName: 'my-site' }],
],
}
```
Or use the top-level option:
```js
export default {
...
modules: [
'nuxt-chargebee',
],
chargebee: {
siteName: 'my-site',
},
}
```
Then you can checkout in your components or open the self-service portal:
```js
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:
```js
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](https://apidocs.chargebee.com/docs/api/portal_sessions).
## Contribute
Are you missing something or want to contribute? Feel free to file an [issue](https://github.com/dword-design/nuxt-chargebee/issues) or a [pull request](https://github.com/dword-design/nuxt-chargebee/pulls)! ⚙️
## 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:
If you want to send me a one time donation. The coffee is pretty good 😊.
Also for one time donations if you like PayPal.
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](https://opensource.org/licenses/MIT) © [Sebastian Landwehr](https://sebastianlandwehr.com)