chargebee

Chargebee Node Client Library - API V2

This is the node.js Library for integrating with Chargebee. Sign up for a Chargebee account here.

Chargebee now supports two API versions - V1 and V2, of which V2 is the latest release and all future developments will happen in V2. This library is for API version V2. If you’re looking for V1, head to chargebee-v1 branch.

Processing Webhooks - API Version Check

An attribute, api_version, is added to the Event resource, which indicates the API version based on which the event content is structured. In your webhook servers, ensure this api_version is the same as the API version used by your webhook server's client library.

Installation

Install the latest version 2.x.x of the library with the following commands:

$ npm install chargebee@">=2 <3"

Then require the library as:

var chargebee = require('chargebee');

Usage

Create an idempotent request

Idempotency keys are passed along with request headers to allow a safe retry of POST requests.

var chargebee = require("chargebee");
chargebee.configure({site : "{site}", api_key : "{site_api_key}"})
chargebee.customer.create({
    first_name : "John",
    last_name : "Doe",
    email : "[e-mail]"
   })
    .setIdempotencyKey("<<UUID>>") // Replace <<UUID>> with a unique string
    .request(function(error,result, headers) {
    if(error){
        //handle error
        console.log(error);
    }else{
        console.log(result);
        console.log(headers); // Retrieves response headers
        console.log(isIdempotencyReplayed); // Retrieves idempotency replayed header value 
        var customer = result.customer;
        var card = result.card;
    }
});

isIdempotencyReplayed() method can be accessed to differentiate between original and replayed requests.

Documentation

The full documentation can be found on the chargebee site here:

https://apidocs.chargebee.com/docs/api?lang=node

License

See the LICENSE file.