npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongoose-stripe-customers

v0.4.0

Published

A mongoose plugin that creates a stripe customer when a new document is created and stores the Stripe customer id to that document.

Downloads

9

Readme

mongoose-stripe-customers

Greenkeeper badge Build Status Coverage Status Dependency Status npm version

A mongoose.js A mongoose plugin that creates a stripe customer when a new document is created and stores the Stripe customer ID to that document.

Use Case

If you are running an ecommerce type application using Stripe and create your own customer/user database objects, as well as Stripe customer objects, use this plugin to simultaneously aggregate your customer information to Stripe when a new customer is created within your database.

This plugin is configurable to allow enough flexibility to work with various schema setups. Just provide the names of your fields such as email or phone and the plugin will map those over to Stripe meta data objects.

Installation

npm install --save mongoose-stripe-customers

API Reference

Example

var mongooseStripeCustomers = require('mongoose-stripe-customers');

var schema = Schema({...});

schema.plugin(mongooseStripeCustomers, {
    stripeApiKey: 'XXXXXXXXXXXXXXXX',
    hook: 'save',
    firstNameField: 'first_name',
    lastNameField: 'last_name',
    emailField: 'email',
    metaData: [ '_id', 'phone', 'customerType' ]
});

mongoose-stripe-customers~options

Kind: inner property of mongoose-stripe-customers

| Param | Type | Default | Description | | --- | --- | --- | --- | | options | object | | | | options.stripeApiKey | string | | The Stripe secret key used to access the Stripe API. | | [options.hook] | string | "save" | The document hook you want this to run before. | | [options.fieldNames] | object | | Response field overrides. | | [options.stripeCustomerIdField] | string | "stripe_customer_id" | The field in which you want the Stripe customer ID value to be stored. | | [options.firstNameField] | string | | The field in which the customer's first name is stored. | | [options.lastNameField] | string | | The field in which the customer's last name is stored. | | [options.emailField] | string | | The field in which the customer's email address is stored. | | [options.metaData[]] | Array.<string> | | If you want any extra data stored with the customer on Stripe, provide an array of field names. |