Please enable JavaScript to view this site.

Chargebee Data Model

Navigation: » No topics above this level «

Chargebee API SQL Driver

Contents Previous Home Next More

Invantive SQL is the fastest, easiest and most reliable way to exchange data with the Chargebee API.

Use the "Search" option in the left menu to search for a specific term such as the table or column description. When you already know the term, please use the "Index" option. When you can't find the information needed, please click on the Chat button at the bottom or place your question in the user community. Other users or Invantive Support will try to help you to our best.

Chargebee is cloud software for subscription invoicing and payment by SaaS-companies.

Chargebee API Clients

Invantive SQL is available on many user interfaces ("clients" in traditional server-client paradigma). All Invantive SQL statements can be exchanged with a close to 100% compatibility across all clients and operating systems (Windows, MacOS, Linux, iOS, Android).

The clients include Microsoft Excel, Microsoft Power BI, Microsoft Power Query, Microsoft Word and Microsoft Outlook. Web-based clients include Invantive Cloud, Invantive Bridge Online as OData proxy, Invantive App Online for interactive apps, Online SQL Editor for query execution and Invantive Data Access Point as extended proxy.

The Chargebee Power BI connector is based on the Invantive SQL driver for Chargebee, completed by a high-performance OData connector which works straight on Power BI without any add-on. The OData protocol is always version 4, independent whether the backing platform uses OData, SOAP or another protocol.

For technical users there are command-line editions of Invantive Data Hub running on iOS, Android, Windows, MacOS and Linux. Invantive Data Hub is also often used for enterprise server applications such as ETL. High-volume replication of data taken from the Chargebee API into traditional databases such as SQL Server (on-premise and Azure), MySQL, PostgreSQL and Oracle is possible using Invantive Data Replicator. Invantive Data Replicator automatically creates and maintains Chargebee datawarehouses, possibly in combination with data from over 70 other (cloud) platforms. Data Replicator supports data volumes up to over 1 TB and over 5.000 companies. The on-premise edition of Invantive Bridge offers an Chargebee ADO.net provider.

Finally, online web apps can be build for Chargebee using App Online of Invantive Cloud.

Monitor API Calls

When a query or DML-statement has been executed on Invantive SQL a developer can evaluate the actual calls made to the Chargebee API using a query on sessionios@DataDictionary. As an alternative, extensive request and response logging can be enabled by setting log-native-calls-to-disk to true. In the %USERPROFILE%\Invantive\NativeLogs folder Invantive SQL will create log files per API request and response.

Specifications

The SQL driver for Chargebee does not support partitioning. Define one data container in a database for each company in Chargebee to enable parallel access for data from multiple companies.

An introduction into the concepts of Invantive SQL such as databases, data containers and partitioning can be found in the Invantive SQL grammar.

The configuration can be changed using various attributes during log on and use. A full list of configuration options is listed in the driver attributes.

The catalog name is used to compose the full qualified name of an object like a table or view. The schema name is used to compose the full qualified name of an object like a table or view. On Chargebee the comparison of two texts is case sensitive by default.

Changes and bug fixes on the Chargebee SQL driver can be found in the release notes. Get access to the Chargebee community through the Chargebee section of the Invantive forums.

Driver code for use in settings.xml: Chargebee

Alias: cbe

Recommended alias: cbe

More technical documentation as provided by the supplier of the Chargebee API on the native APIconnection used can be found at https://apidocs.chargebee.com/.

General documentation on Chargebee is available at https://www.chargebee.com/

Authentication

Authentication is done using an API key. An API key can be found and/or registered on https://SERVER/apikeys_and_webhooks/api.

Beware that after deleting records, Chargebee can still return those records for some time (at least 5 seconds).

12-12-2020 18:45 Version 20.1.301-BETA+3023