Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 3.01 KB

README.md

File metadata and controls

82 lines (58 loc) · 3.01 KB
Raw

node-stripe

Access to the Stripe API.

Installation

npm install node-strip

Usage overview

var api_key = 'abc';  // secret stripe API key
var stripe = require('stripe')(api_key);

stripe.customers.create(
   { email: '[email protected]' },
   function(err, customer) {
      if (err) {
         console.log("Couldn't create the customer record");
         return;
      }
      console.log("customer id", customer.id);
   }
 );

API

All methods takes a callback as their last parameter. The callback is called with an error code (if any) and then the response.

  • stripe.charges - create, retrieve, refund and list charges
    • `.create(charge) - create a charge
    • `.retrieve(charge_id) - retrieve a charge by charge id
    • `.refund(charge_id, amount) - refund a given charge, amount in cents
    • `.list(data) - List charges
  • stripe.customers - create, retrieve, update and delete customers
    • .create(customer) - create a customer, takes the data as an object
    • .retrieve(customer_id) - retrieve a customer by customer id.
    • .update(customer_id, updates) - update a customer; updates is an object with new parameters
    • .del(customer_id) - mark the customer deleted
    • .list(count, offset) - List customers
  • stripe.tokens - Tokens API

TODO

See the issue tracker.

Tests

To run the tests, install vows with npm install vows and then run

STRIPE_API=your-test-api-key vows tests/*

Author

Ask Bjørn Hansen ([email protected]). Development was sponsored by YellowBot.

License

Copyright (C) 2011 Ask Bjørn Hansen

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.