metrics-stripe-charges

metrics-stripe-charges

A Stripe charges plugin for segmentio/metrics.

Use this plugin to visualize Stripe charges over time.

Installation

$ npm install metrics-stripe-charges

Quickstart

Here's a full example of a Geckoboard dashboard showing Stripe charge metrics:

var Metrics = require('metrics');
var charges = require('metrics-stripe-charges');
var geckoboard = require('geckoboard')('api-key');

new Metrics()
  .every('10m', charges('stripe-key'))
  .use(function (metrics) {
    metrics.on('stripe charged', function (metric) {
      geckoboard('widget-id').number(metric.latest());
    });
  });

Filter Customers

You can further filter customers using stripe-charges filters:

new Metrics()
  .every('10m', charges('stripe-key', { filter: filter }));

function filter (charge) {
  return charge.customer !== 'cus_8239d2jd9j'; // filter enterprise customer X
}

Metrics

The metrics exposed by this plugin are:

• stripe charges - the number of charges
• stripe charged - the dollar amount charged

and are calculated for the last 30 days, last 52 weeks, and last 10 years.

License

MIT