mongoose-stripe-customer

A Mongoose plugin to handle and validate stripe customers and their subscription plans

npm install mongoose-stripe-customer
4 downloads in the last week
9 downloads in the last month

Mongoose stripe customer plugin

Build Status Coverage Status

Mongoose plugin to manage stripe plans and recurring payments. Add it to your users/accounts table to store:

  • stripe customer id
  • stripe plan id
  • last 4 digits of the payment method (for display purposes)
  • next stripe plan billing date (for display purposes)

Requirements

  • Node.js
  • mongoDB
  • Stripe account

API

stripe customer id

  • setStripeCustomerId(customerId)
  • getStripeCustomerId()

stripe plan

  • setPlan(plan)
  • getPlanName()
  • getPlanPrice()
  • isFreePlan()
  • isNoPlan()
  • isValidPurchasePlan(plan)
  • compareToPlan(plan)

last 4 digits of the payment method

  • setLast4(last4)
  • getLast4()
  • isCardOnFile()
  • resetCard()

next stripe plan billing date

  • setNextBillingDate(billingDate)
  • getNextBillingDate()

Usage

Install

$ npm install mongoose-stripe-customer

Test (requires mongodb installed locally)

$ npm test

Example

// load
var stripeCustomer = require('mongoose-stripe-customer');

// define your schema
var MySchema = new mongoose.Schema({...});

// define plans
var plansPricing = {
    'BASIC' : { name : 'Basic', price : 9.99 },
    'TEAM'  : { name : 'Team',  price : 19.99 },
    'GOLD'  : { name : 'Gold',  price : 29.99 }
};

// add the plugin
MySchema.plugin(stripeCustomer, { 

    // the plans you defined
    plans : plansPricing,

    // set the default plan
    defaultPlan : stripeCustomer.plans.FREE,

    // a callback for when a new plan is assigned
    onPlanGiven : function (doc, plan) {
        // do something
    }

});

License

(The MIT License)

Copyright (c) 2013 <alex@binarypattern.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you