node package manager


Stripe Node.js Library

Version Build Status Downloads Try on RunKit

The Stripe Node library provides convenient access to the Stripe API from applications written in server-side JavaScript.

Please keep in mind that this package is for use with server-side Node that uses Stripe secret keys. To maintain PCI compliance, tokenization of credit card information should always be done with Stripe.js on the client side. This package should not be used for that purpose.


See the Node API docs.


Install the package with:

npm install stripe --save


The package needs to be configured with your account's secret key which is available in your Stripe Dashboard. Require it with the key's value:

var stripe = require('stripe')('sk_test_...');
  { email: '' },
  function(err, customer) {
    err; // null if no error occurred 
    customer; // the created customer object 

On ES6, this looks more like:

import stripePackage from 'stripe';
const stripe = stripePackage('sk_test_...');

Using Promises

Every method returns a chainable promise which can be used instead of a regular callback:

// Create a new customer and then a new charge for that customer: 
  email: ''
  return stripe.customers.createSource(, {
    source: {
       object: 'card',
       exp_month: 10,
       exp_year: 2018,
       number: '4242 4242 4242 4242',
       cvc: 100
}).then(function(source) {
  return stripe.charges.create({
    amount: 1600,
    currency: 'usd',
    customer: source.customer
}).then(function(charge) {
  // New charge created on a new customer 
}).catch(function(err) {
  // Deal with an error 

Configuring Timeout

Request timeout is configurable (the default is Node's default of 120 seconds):

stripe.setTimeout(20000); // in ms (this is 20 seconds) 

Configuring For Connect

A per-request Stripe-Account header for use with Stripe Connect can be added to any method:

// Retrieve the balance for a connected account: 
  stripe_account: "acct_foo"
}).then(function(balance) {
  // The balance object for the connected account 
}).catch(function(err) {
  // Error 

Configuring a Proxy

An https-proxy-agent can be configured with setHttpAgent.

To use stripe behind a proxy you can pass to sdk:

if (process.env.http_proxy) {
  const ProxyAgent = require('https-proxy-agent');
  stripe.setHttpAgent(new ProxyAgent(process.env.http_proxy));

Examining Responses

Some information about the response which generated a resource is available with the lastResponse property:

charge.lastResponse.requestId // see: 

More Information


Run all tests:

$ npm install
$ npm test

Run a single test suite:

$ npm run mocha -- test/Error.spec.js

Run a single test (case sensitive):

$ npm run mocha -- test/Error.spec.js --grep 'Populates with type'

If you wish, you may run tests using your Stripe Test API key by setting the environment variable STRIPE_TEST_API_KEY before running the tests:

$ export STRIPE_TEST_API_KEY='sk_test....'
$ npm test