Chargebee

This documentation for the Chargebee integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Chargebee, visit our connection instructions.

Version

This integration utilizes the Chargebee API v2.

Base URL

The base URL used for all Chargebee API endpoints contains the Subdomain:

https://subdomain.chargebee.com/api/v2

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/customers	Validate credentials

---

Authentication & Authorization

The DataGrail Chargebee integration connects using basic authentication which requires an API Key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Chargebee API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

---

Limits

Limits in Chargebee are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Chargebee integration provides Asynchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search Customers using configured identifiers.
2. If a match is found, DataGrail will extract all objects related to the customer, including the following:

Match Found

• subscriptions
• payment_sources
• virtual_bank_accounts
• promotional_credits
• invoices
• credit_notes
• unbilled_charges
• orders
• gifts
• transactions
• quotes

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/customers	Search customers

---

Deletion

DataGrail's Chargebee integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Search Customers using configured identifiers.
2. Extract Customer ID.
3. Fetch Subscriptions using Customer ID.
4. Check Site configurations.
5. Cancel all customer's subscriptions with immediate effect.
6. Clear Personal Data for relevant customers.
7. Retrieve a Customer

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/configurations	Check site configurations
GET	/customers	Search customers
GET	/customers/customer_id	Retrieve a customer
POST	/customers/customer_id/clear_personal_data	Clear personal customer data
GET	/subscriptions	Fetch subscriptions
POST	/subscriptions/subscription_id/cancel	Cancel a subscription
POST	/subscriptions/subscription_id/cancel_for_items	Cancel subscription for items

---