prorate

    0.2.2 • Public • Published

    prorate

    Compute billing subscription upgrades, downgrades and prorated amounts. Uses Big.js to ensure accuracy of calculations.

    Installation

    npm install prorate --save

    Usage

    When starting a subscription use the signup method to comute the amount to bill the user.

    var prorate = require('prorate');
    var percent = prorate.monthPercentage(); //between 0 and 1
    var planPrice = 1.00;
    var amount = prorate.signup(percent, planPrice);

    The usage for a subscription plan upgrade or downgrade is handled by the change method.

    var prorate = require('prorate');
    var percent = prorate.monthPercentage(); //between 0 and 1
    var planPrice1 = 1.00;
    var planPrice2 = 2.00;
    var amount = prorate.change(percent, planPrice1, planPrice2);

    The usage for a subscription plan cancellation is handled by the cancel method.

    var prorate = require('prorate');
    var percent = prorate.monthPercentage(); //between 0 and 1
    var planPrice = 1.00;
    var amount = prorate.cancel(percent, planPrice);

    There is a convience method monthPercentage to aid in calculating the percentage of time.

    var prorate = require('prorate');
     
    // using current time
    var percentNow = prorate.monthPercentage();
     
    // using a date
    var date = new Date('December 17, 1995 03:24:00');
    var percentDate = prorate.monthPercentage(date);
     

    Tests

    npm install -g mocha
    npm install -g chai
    mocha test

    Code Quality

    npm install -g eslint
    eslint .

    People

    The current maintainer is Dan Hollenbeck.

    LICENSE

    MIT

    Install

    npm i prorate

    DownloadsWeekly Downloads

    2

    Version

    0.2.2

    License

    MIT

    Last publish

    Collaborators

    • dhollenbeck