stripe-charge-list

Handy wrapper around stripe charge list API

stripe-charge-list

A Stripecharges API for node - get a time based overview of how much you're making. Based off stripe-charges.

Installation

npm install stripe-charge-list

Example

Query charges by their createddate:

var ChargeList = require('stripe-charge-list')

var list = ChargeList('stripe-key')

list.get(new Date('1/1/2014'), new Date('2/1/2014'), function (err, charges) {
  console.log('Made $' + charges.total() + ' in January!');
});

The resulting chargesobject lets you further learn manipulate the charges.

Number of Charges

Get the number of charges returned:

charges.count()

or filter further inside the cohort by the charges' createddate:

charges.count(new Date('1/15/2014'), new Date('1/24/2014'));

API

var list = ChargeList(key, [opts])

  • key- stripe key, required
  • opts.limit- limit number of results from each query
  • opts.fee - { pct: 0.029, amt: 0.3}set fees for calculating actual earnings (only needs to be set if you do not have default pricing).

list.get(start, end, callback(err, charges))

Get charges between startand enddates (must be date objects). callbackreturns a chargesobject (see below).

chargesAPI

charges.list()
[
  {
    amount: 2900,
    customer: 'cus_2983jd92d2d',
    ..
  },
]

Filter charges via a filter function:

charges.filter(fn)

or filter further by the charges' createddate:

charges.list(new Date('1/15/2014'), new Date('1/24/2014'))

or get all the refundedcharges:

charges.refunded(true).count()

Handy printing to console.log:

charges.print()

Total Amount

You can get the total amount of money made from the charges:

charges.paid(true).refunded(false).total()

License

MIT

Forked from stripe-charges.

HomePage

https://github.com/joehand/stripe-charge-list#readme

Repository

https+https://github.com/joehand/stripe-charge-list


上一篇:igroot-text-diff
下一篇:igroot-tags

相关推荐

官方社区

扫码加入 JavaScript 社区