ChargeBee API Documentation

This is the complete API documentation for connecting to the ChargeBee API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet ChargeBee: Chargebee is a subscription billing and revenue management platform for managing customers, subscriptions, invoices, credit notes, payments, events, products, and catalog data through Chargebee's REST API. Keep reading to get started.

Quickstart

Before you run your first ChargeBee request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ChargeBee connection — create or choose one in Connections. Note its connectionId.

Every ChargeBee action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/chargeBee/latest/actions/{actionSlug}

You need a MindCloud API Key and a ChargeBee connection. Then call an action such as List Business Entities:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chargeBee/latest/actions/list-business-entities" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected ChargeBee account that should run the action. MindCloud stores and refreshes the ChargeBee credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

ChargeBee actions

All 31 published actions for this ChargeBee version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Customer
• GETList Business Entities
• GETList Coupons
• GETList Credit Notes
• GETList Customers
• GETList Events
• GETList Hosted Pages
• GETList Invoices
• GETList Item Prices
• GETList Items
• GETList Orders
• GETList Payment Sources
• GETList Promotional Credits
• GETList Quotes
• GETList Subscriptions
• GETList Transactions
• GETList Unbilled Charges
• GETList Usages
• GETList Virtual Bank Accounts
• GETRetrieve Business Entity
• GETRetrieve Coupon
• GETRetrieve Credit Note
• GETRetrieve Customer
• GETRetrieve Event
• GETRetrieve Invoice
• GETRetrieve Item
• GETRetrieve Item Price
• GETRetrieve Payment Source
• GETRetrieve Subscription
• GETRetrieve Transaction
• PUTUpdate Customer

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionHubSpotGoogle Forms