Chargebee v2 Docs

The Chargebee V2 element is available in the payment hub.

On this page:

Authentication Prerequisites

The Chargebee V2 element uses the basic authentication workflow. Before you can authenticate an instance of the Chargebee V2 element, you will need a Chargebee account in LIVE or Test site.

To generate or retrieve credentials for your Chargebee account, follow these steps:

  1. On the left, go to Settings.

  2. Open Configure Chargebee. 

  3. Click Add API key.

  4. Select the desired API Key access.

  5. Set the API key name. Click Create Key.

  6. Copy the API Key and input this value as your username during authentication.

Required Authentication Parameters

You can authenticate an element instance using the UI or via API calls. For detailed information on how to authenticate an instance, see our related documentation:

To authenticate an instance of the Chargebee V2 element, you will need the following parameters:

Parameter Name/UI ValueAPI ValueDescriptionSource
NamenameThe name of your element instancen/a
Sitesitethe site subdomain is mentioned hereContained in your Chargebee site's URL
UsernameusernameThe user identity name is mentioned hereThe API Key value you retrieved in after creating your app.
PasswordpasswordThe account password is entered hereYour Chargebee account password; contact your Chargebee administrator for details.

Element Fact Sheet and Reference

Authentication and Configuration Parameters

To see all authentication parameters for the Chargebee V2 element, follow these steps:

  1. Sign in to Cloud Elements and navigate to Elements.
  2. Hover over the card for an element, and then click My Resources
  3. In the top navigation toolbar, click Setup.
  4. From the Setup page, you can view a complete list of the element's authentication and configuration parameters.

Events and Supported Resources

The Chargebee V2 element supports events via webhooks. For detailed information about our Events framework and how to configure an element instance with events, see our documentation:

You can set up polling events for the events resource element.

Queryable Endpoints

You can use CEQL to query the following endpoints of the Chargebee V2 element:

  • GET /bulk/jobs
  • GET /customers
  • GET /events
  • GET /invoices
  • GET /{objectName}
  • GET /plans
  • GET /subscriptions
  • GET /transactions

Note: In compliance with our security and privacy policies, the 'Try it Out' feature in the API docs and Resources tab has been disabled for some resources in this element. For more information and a list of the affected resources, see our documentation.

The base URL for all API requests is