Integrating Chargebee

Capabilities

DataGrail's Chargebee integration provides the following capabilities:

Product	Capability
Request Manager	Request Types Access, Deletion Identifier Categories Email

Before You Start

To successfully configure this integration, please ensure you have sufficient privileges:

• DataGrail User Role: Super Admin, Connections Manager
• Chargebee User Role: Admin

Get Chargebee API Key

1. Log in to Chargebee.
2. In the left menu under Settings, navigate to Configure Chargebee.
3. Scroll down to the API Keys and Webhooks section, and select API Keys.
4. Select Add API Key.
5. Choose a Full-Access Key, enter a Name and select Create Key.
6. Navigate to the API Keys tab and select your new key from the list.
7. Copy the API Key and store it in a secure, temporary location.
8. Check the URL and copy the subdomain to get your Site. For example, if the URL is https://mycompany.chargebee.com, then your Site will be mycompany.
9. Navigate back to Configure Chargebee, scroll down to Customer Data Privacy and select Personal Data.
10. Under Data Retention Period, we recommend setting it to Immediately to enable the immediate removal of a Customer's personal data on your request.

Connect to DataGrail

1. In DataGrail, navigate to Integrations and select Configure New Integration to search for Chargebee.
2. Enter the API Key and Site.
3. Select your desired Asynchronous Deletion Behavior.

Chargebee Deletion Behavior Configuration

Mark integration as complete when a deletion request is successfully submitted: The Chargebee Integration will be marked as "complete" as soon as the deletion request is submitted to Chargebee.

Continue processing until the deletion request is completed (default behavior): The Chargebee Integration will show a "processing" status until the Chargebee deletion is complete.

4. Select Configure Integration.

Next Steps

Now that you've successfully connected the integration, check out the following resources:

• Synchronous vs. Asynchronous Integrations
• Whole Record Deletion
• Access Request Lifecycle
• Deletion Request Lifecycle

Troubleshooting

If you are unable to successfully connect the integration, review these common troubleshooting steps:

Ensure Required Permissions Are Granted on API Keys/Resources

DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.

Review Required Account Types and User Roles

If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.

See Before You Start to review these requirements.

Technical Details

The Chargebee integration uses the v2 API with both Product Catalog versions:

Access Type	Asynchronous
Deletion Type	Asynchronous (Whole Record)

API Documentation

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.