Settings
API Version
Product Catalog
Library

Getting started

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 a "easy to use" wrapper around the raw HTTP based API.

If you require support for additional languages, please raise a ticket on our support page.

Sample Snippets

Use the language bar at the top to view code examples in your chosen language.

Want us to generate ready-to-test snippets?

to Chargebee and open the API docs from there and you'll find ready-to-test sample codes based on your Chargebee test site's api key and data.
Don't have an account with Chargebee yet? .

Sample Apps

Explore our suite of sample applications, complete with tutorials to guide your integration with Chargebee.

Documentation

For in-depth explanations and definitions of all Chargebee components, consult our documentation.

Resources

Chargebee follows the REST model of exposing resources as urls. For example, subscriptions are exposed as

https://{site}.chargebee.com/api/v1/subscriptions

Request

The HTTP method (like GET,POST) determines the operation type on the resource. Query parameters allow you to provide additional options to the GET requests. POST parameters provide the data to write operations like creation, modification of resource(s).

By default curl uses GET method. Use -X option to specify a specific HTTP method to use. For passing parameters, use -d option.

Note: cURL automatically uses the POST method if any parameter is sent via -d option.

Response

The response is in JSON format. Currently Chargebee does not support any other response format.

Note: Sometimes, while working with Chargebee APIs, you may see undocumented attributes returned in the response. Such attributes should be ignored.

Sample Request
undefined

Sample Response [ JSON ]

undefined

If you are calling our APIs without any of the client libraries, you can set the User-Agent header to a custom value to differentiate API calls from different applications and help with troubleshooting.

Sample request with custom User-Agent header
curl https://{site}.chargebee.com/api/v2/customers \
     -X POST \
     -H 'User-Agent: my-app' \
     -u {site_api_key}: \
     -d first_name="John" \
     -d last_name="Doe" \
     -d email="john@test.com"

Using cURL

You can use cURL to test Chargebee API from a CLI. When you pass input parameters to the API using -d or --data-urlencode options, the HTTP POST method is used:

curl https://{site}.chargebee.com/api/v1/subscriptions/{subscription_id}/change_term_end
    -u {site_api_key}:\
    -d term_ends_at=1601490600

When no input parameters are provided, cURL uses the GET method by default: 
curl https://{site}.chargebee.com/api/v1/subscriptions/{subscription_id} \
    -u {site_api_key}:

To make a POST request without providing any input parameters, use the -X POST option: 
curl -X POST https://{site}.chargebee.com/api/v1/exports/subscriptions \     -u {site_api_key}:

Further, to make GET requests with parameters, you must use the -G option: 
curl -X POST https://{site}.chargebee.com/api/v1/v2/orders \
    -G  \
    -u {site_api_key}:\
    --data-urlencode limit=3 \
    --data-urlencode status[is]="queued"

OpenAPI Specification

Chargebee supports the OpenAPI Specification to make it easier for developers to work with our APIs.

The spec is fully compliant with OpenAPI v3.0.1, enabling customers to:

  • Use API development tools like Swagger and Postman
  • Automate testing and documentation workflows

This is part of our commitment to providing a smoother, more efficient developer experience.

Code samples

The sample code snippets provided for the endpoints in this documentation are ready-to-test. Once you log in and select a test site using the dropdown that appears at the top, the code samples in this documentation automatically include your API key and site data.

API testing

Chargebee provides the Time Machine feature to help you test your integration. Once you've set up your billing configuration on the test site, you can simulate events on a hypothetical time frame to ensure everything works as expected. Ensure that you rigorously test your configuration before going live.

Additional developer resources

Check out our collection of sample applications and related tutorials for integrating with Chargebee.