API OVERVIEW:

Chargebee provides HTTP based API which follows the essence of REST*. The HTTP protocol's rules are followed thereby enabling simple HTTP client tools like "curl" to be used.

The following client libraries provide an "easy to use" wrapper around the raw HTTP based API.

Please do mail us at support@chargebee.com if you need any other language bindings.


API VERSIONS:

Chargebee now supports two API versions - V1 and V2. V2 version has been released to accommodate certain backwards-incompatible changes that we wanted to make over V1 for a more streamlined functionality.

All further developments will happen in V2. However we will continue to support V1 in order to avoid breaking your code.


DOWNLOADING/INSTALLING CLIENT LIBRARIES:

As we support multiple API versions now, we request you to

  • Use the appropriate GitHub branches if you are building from source. The master branch will have the API V2 code, and chargebee-v1 branch will have the API V1 code.
  • Use appropriate version specifiers, if you are installing/updating using package managers (composer, gem, pip, easy_install, maven, NuGet, npm, etc.). More details here

WEBHOOKS AND API VERSIONS:

With multiple versions of API being supported, the property Api Version has been added to Webhooks, which decides the structure of the event content sent to the webhooks.


WHICH API VERSION AM I USING?

Find out the version of the API you are using, with the following indicators:

  • The Chargebee client lib release version: Release versions 1.x.x indicate that you're on V1 and 2.x.x indicate that you are on V2.
  • The API end-points: They start with /api/v1 for V1 and /api/v2 for V2.


The extensive API documentation will make your integration a breeze. Find out some great API tutorials below:


HOSTED PAYMENT PAGES:

Implement an in-app hosted checkout using the drop-in script

Upgrade the existing subscription from trial to paid plan using in-app checkout.


ADVANCED CHECKOUT OPTIONS:

Build your custom checkout form with the dynamically changing order summary

Build an in-app popup checkout form using Stripe.js

Build an in-app checkout form by embedding Stripe.js


OTHER API SAMPLES:

Build an in-app checkout form using Braintree.js

Create a portal for your customers

Get additional customer information with custom fields

Metered billing using Webhooks with the Invoice API