API Data Provider - Online Help

Connecting to Chargebee

Chargebee uses Token authentication to control access to its API.

Using Token Authentication

In order to authenticate to Chargebee, you'll need to provide your Site and API Key.

To create and configure the API keys, from your Chargebee account, select Settings > Configure Chargebee > API Keys and Webhooks and then click on the API Keys tab. Any existing API keys are listed. To create a new API key, click on the Add an API Key button, choose the type of key to create, give it a name and click Create Key.

Additionally, you will need to set the Site, found in the URL of your Chargebee account. For example if your Chargebee account URL is acmeinc.chargebee.com, then the Site should be 'acmeinc'. Set both the API Key and the Site in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\Chargebee.apip;ProfileSettings='Site=acmeinc;APIKey=my_api_key';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your Chargebee API Key.
Site Your Chargebee site name.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060.0