QuotaPath's integration with Chargebee allows you to easily import data from your Chargebee account to use in QuotaPath to calculate commissions or inform payouts eligibility. In this article, we'll cover the requirements to set up this integration and provide step-by-step instructions.
Integration Requirements
Before connecting Chargebee to your QuotaPath workspace, you'll need to obtain the below information.
Site: The site prefix for your Chargebee instance.
API Key: Chargebee API Key.
For more information on obtaining the API Key, visit Chargebee's documentation here.
Product Catalog: Product Catalog version of your Chargebee site.
For more information on obtaining the API Key, visit Chargebee's documentation here.
Start Date: UTC date and time in the format 2021-01-25. Any data before this date will not be replicated.
Once you have the above information, you're ready to connect Chargebee to your QuotaPath workspace!
Supported Objects
QuotaPath supports the ability to import the following objects from Chargebee:
Add on
Attached item
Contact
Coupon
Credit note
Customer
Event
Gift
Hosted page
Invoice
Item
Item price
Order
Payment source
Plan
Promotional credit
Quote
Quote line group
Subscription
Transaction
Unbilled charge
Virtual bank account
How to connect Chargebee
To connect Chargebee to your QuotaPath workspace, open Integrations in the Data group of the left-hand navigation (it is not under Settings). If you already have a source connected, you will land on Connected; otherwise you will see Available. Find the Chargebee integration card and click ‘Connect’.
Integration Source Form
Enter the above information into the integration source form shown below and click 'Submit' when complete.
After receiving the confirmation that the integration has been successfully connected, click 'Next' to proceed.
Sync Schedule
At the top of the following screen, use the dropdown selector to set the sync frequency. After the source is connected, open the Chargebee card and choose Manage source. To pull the latest records, an Admin clicks Sync and Refresh on the source page (that action is admin-only).
Objects
Next, select the objects that you'd like to import into your QuotaPath workspace.
When complete, click ‘Sync now’ to begin importing data into your QuotaPath workspace. This could take a few minutes so feel free to close the modal and navigate back to Home to complete any outstanding onboarding tasks. We will send you an email once your integration is ready to use.
Once your integration is set up, you can map a component to this data. Visit How to Map a Component to your Data Source for more detailed instructions!