Getting started

Important

Starting November 1, 2025, Chargebee will briefly rotate TLS certificates on weekends to help you validate. The new DigiCert G2 chain becomes permanent in February 2026. If you don't update, API calls may fail with SSL errors. Learn more about the TLS G2 certificate update.

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.

Chargebee also maintains official client libraries that wrap the HTTP API. See Client Libraries for supported languages and installation instructions.

Sample Snippets

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

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:

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.

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.

Sample Request

Sample ResponseJSON

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

Select a language from the SDK dropdown above to see examples in your preferred language. After logging in, code samples will use your actual API key and site data.

Client library

Chargebee maintains official open-source client libraries for PHP, Ruby, Python, Java, .NET, Node, and Go. See Client Libraries for installation instructions, code samples, and links to each repository.

To view this API reference tailored to the programming language of your choice, select the language in the "Library" dropdown above. Reach out to us at dx@chargebee.com if you'd like to request any other language bindings.

Note

Select the programming language of your choice from the "Library" dropdown at the top of the page.

Build with LLMs

Chargebee's API is designed to work seamlessly with Large Language Models (LLMs) and AI assistants. The structured API definitions and comprehensive documentation make it easy to integrate Chargebee into AI-powered applications.

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.