Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Set up the Chargebee integration

Set up the Chargebee integration to retrieve recurring billing and subscriptions data from your SMB customers

Before you can use the integration, your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customers (merchants who use Chargebee) need to retrieve their secure APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. credentials from their Chargebee account and enter them in Link. Chargebee does not require any global credentials for accessing the APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms..

To start reading data from Chargebee:

  • Enable the Chargebee integration
  • Create companies in Codat and then share the LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. URLs with your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customers
  • Ask you customer to connect their Chargebee account to Codat

Enable the Chargebee integration

  1. In the Codat Portal, go to the Commerce integrations page.
  2. Locate Chargebee and click the toggle to enable the integration.

You can also click Manage to view the integration's settings page, and then enable the integration from there.

Options for SMB authentication

Using LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. for SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. authentication is optional. You can also build your own authentication flow using the Codat APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. (the platform key for Chargebee is required).

In the Codat Portal:

  1. Click Companies > New companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources..
  2. In the Add new companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. dialog, enter a name for the companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources., then clicks Add. The LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. URL is displayed.
  3. Provide the LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. URL to your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customers.

SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customer: Connects their Chargebee account to Codat

Your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customer connects their Chargebee account to Codat using LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat.. To authenticate with Codat, they need to get their APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. Key from Chargebee.

For help with this procedure, see Creating an API key in the Chargebee documentation.

Your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customer performs the following steps:

  1. Opens the LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. URL in their browser.

  2. On the Commerce step in LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat., they select the Chargebee tile, then clicks Next.

  3. Reviews the requested permissions on the Connect to Chargebee page, then clicks Next.

    The Your Chargebee credentials page is displayed.

    Your Chargebee credentials

  4. Opens a new browser tab and signs in to their Chargebee account.

  5. In the side panel, clicks Settings then clicks Configure Chargebee.

  6. In the APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. Keys and WebhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. section, clicks APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. Keys to view their APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key.

  7. On the Your Chargebee credentials page, they enter the following details:

    • Chargebee site name. This is part of the URL, for example, https://site-name.chargebee.com.
    • Chargebee APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key.
  8. Clicks Continue.

  9. If the data connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. was successful, they click Finish to close LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat..

Your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customer has now connected their Chargebee account to Codat.


Was this page useful?
👏
👍
🤔
👎
😭