Chargebee Node.js / TypeScript client library (Beta)

This is the Node.js library for integrating with Chargebee. Sign up for a Chargebee account here.

Please refer to the migration guide if you are migrating from the older versions of chargebee-typescript or chargebee.

Requirements

Node.js 18 or higher.

Installation

Install the beta version of the library with npm:

npm install chargebee@beta

With pnpm:

pnpm add chargebee@beta

With yarn:

yarn add chargebee@beta

Usage

The package needs to be configured with your site's API key, which is available under Configure Chargebee Section. Refer here for more details.

If you're using ESM / TypeScript:

import Chargebee from 'chargebee';

const chargebee = new Chargebee({
  site: "{{site}}",
  apiKey: "{{api-key}}",
});

Or using Common JS module system:

const Chargebee = require('chargebee');

const chargebee = new Chargebee({
  site: "{{site}}",
  apiKey: "{{api-key}}",
});

Using Async / Await

try {
  const { customer } = await chargebee.customer.create({
    email: "john@test.com"
    // other params
  });
} catch (err) {
  // handle error
}

Using filters in the List API

For pagination, offset is the parameter that is being used. The value used for this parameter must be the value returned for next_offset parameter in the previous API call.

async function getAllCustomers() {
  const allCustomers: Customer[] = [];
  let offset: string | undefined = undefined;

  do {
    const listCustomersReponse = await chargebee.customer.list({
      limit: 2,
      offset,
      first_name: {
        is: "John"
      }
    });

    const customers = listCustomersReponse.list.map(
      (object) => object.customer
    );
    
    allCustomers.push(...customers);
    offset = listCustomersReponse.next_offset;
  } while (offset);

  console.log(allCustomers);
}

Using custom headers and custom fields

const { customer } = await chargebee.customer.create(
  {
    email: "john@test.com",
    cf_host_url: "http://xyz.com" // `cf_host_url` is a custom field in Customer object
  },
  {
    "chargebee-event-email": "all-disabled" // To disable webhooks
  }
);

Creating an idempotent request

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

const { customer, isIdempotencyReplayed } = await chargebee.customer.create(
  { email: "john@test.com" },
  {
    "chargebee-idempotency-key": "eBs7iOFQuR7asUKHfddyxDDerOuF1JtFrLmDI" // Add idempotency key
  }
);
console.log("isIdempotencyReplayed: ", isIdempotencyReplayed);

Creating multiple instances of Chargebee for different sites

const chargebeeSiteUS = new Chargebee({
  apiKey: "{api-key}",
  site: "my-site-us"
});

const chargebeeSiteEU = new Chargebee({
  apiKey: "{api-key}",
  site: "my-site-eu"
});

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.

Feedback

If you find any bugs or have any feedback, open an issue in this repository or email it to dx@chargebee.com

License

See the LICENSE file.