Skip to main content

Authorization

Follow this guide to create a new Chargebee credential that will allow Nexla to authenticate to and exchange data with your Chargebee account.
chargebee_api_auth.png

Chargebee

Prerequisites​

Before creating a Chargebee credential, you need to obtain an API key from your Chargebee account. Chargebee uses Basic Authentication with the API key as the username and an empty password to authenticate API requests.

To use Chargebee with Nexla, you need:

  • Access to your Chargebee account
  • A Chargebee account with appropriate permissions to access the resources you want to work with
  • Your API key for Basic Authentication
  • Your Chargebee site identifier

The Chargebee API requires your site identifier, which is the {your-site} part of your Chargebee URL (e.g., if your Chargebee URL is https://mycompany.chargebee.com, your site identifier is mycompany). For detailed information about Chargebee authentication, API key setup, and available resources, refer to the Chargebee API documentation.

Create a Chargebee Credential​

  • To create a new Chargebee credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Chargebee

ChargebeeCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

  1. Enter your Chargebee site identifier in the Site field. This is the {your-site} part of your Chargebee URL (e.g., if your Chargebee URL is https://mycompany.chargebee.com, enter mycompany). The site identifier is used to construct the API endpoint URLs.

  2. Enter your Chargebee API key in the API Key field. This is the API key you obtained from your Chargebee account settings. The API key is used as the username for Basic Authentication, with an empty password.

    Keep your API key secure and do not share it publicly. The API key provides access to your Chargebee account and should be treated as sensitive information. Chargebee uses Basic Authentication with the API key as the username and an empty password. The API key is sent in the Authorization header for all API requests to the Chargebee API. For detailed information about obtaining and managing API keys, see the Chargebee API authentication documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.