Skip to content

Commit 549759b

Browse files
JustinASmithJustinASmith
committed
docs: add source-chargebee-native
- New documentation for the Chargebee Native connector, detailing its capabilities, supported resources, prerequisites, configuration options, and sample usage. - Deprecate old Chargebee connector.
1 parent 6b3165c commit 549759b

File tree

3 files changed

+103
-3
lines changed

3 files changed

+103
-3
lines changed

‎site/docs/reference/Connectors/capture-connectors/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -224,9 +224,12 @@ Typically, we enable SaaS connectors from third parties to allow more diverse da
224224
- Braze
225225
- [Configuration](./braze.md)
226226
- Package - ghcr.io/estuary/source-braze:dev
227-
- Chargebee
227+
- Chargebee (deprecated)
228228
- [Configuration](./chargebee.md)
229229
- Package - ghcr.io/estuary/source-chargebee:dev
230+
- Chargebee
231+
- [Configuration](./chargebee-native.md)
232+
- Package - ghcr.io/estuary/source-chargebee-native:dev
230233
- Confluence
231234
- [Configuration](./confluence.md)
232235
- Package - ghcr.io/estuary/source-confluence:dev

‎site/docs/reference/Connectors/capture-connectors/chargebee-native.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Chargebee Native
2+
3+
This connector captures data from Chargebee into Flow collections in real-time. It is a native implementation that provides enhanced performance and reliability compared to the third-party connector.
4+
5+
It is available for use in the Flow web application. For local development or open-source workflows, [`ghcr.io/estuary/source-chargebee-native:dev`](https://ghcr.io/estuary/source-chargebee-native:dev) provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.
6+
7+
## Supported data resources
8+
9+
The connector supports many Chargebee resources, which vary based on your Product Catalog version. Below is a comprehensive list of available resources and their capabilities:
10+
11+
| Stream | Product Catalog 1.0 | Product Catalog 2.0 | Incremental | Full Refresh | Notes |
12+
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------- | ----------- | ------------ | ------------------------------------ |
13+
| [Addons](https://apidocs.chargebee.com/docs/api/addons?prod_cat_ver=1#list_addons) | ✓ | - | ✓ | - | - |
14+
| [Attached Items](https://apidocs.chargebee.com/docs/api/attached_items?prod_cat_ver=2#list_attached_items) | - | ✓ | ✓ | - | Associated with Items |
15+
| [Comments](https://apidocs.chargebee.com/docs/api/comments?prod_cat_ver=2#list_comments) | ✓ | ✓ | ✓ | - | - |
16+
| [Contacts](https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#list_of_contacts_for_a_customer) | ✓ | ✓ | - | ✓ | Associated with Customers |
17+
| [Coupons](https://apidocs.chargebee.com/docs/api/coupons?prod_cat_ver=2#list_coupons) | ✓ | ✓ | ✓ | - | - |
18+
| [Credit Notes](https://apidocs.chargebee.com/docs/api/credit_notes?prod_cat_ver=2#list_credit_notes) | ✓ | ✓ | ✓ | - | - |
19+
| [Customers](https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#list_customers) | ✓ | ✓ | ✓ | - | - |
20+
| [Differential Prices](https://apidocs.chargebee.com/docs/api/differential_prices?prod_cat_ver=2#list_differential_prices) | - | ✓ | - | ✓ | - |
21+
| [Events](https://apidocs.chargebee.com/docs/api/events?prod_cat_ver=2#list_events) | ✓ | ✓ | ✓ | - | - |
22+
| [Gifts](https://apidocs.chargebee.com/docs/api/gifts?prod_cat_ver=2#list_gifts) | ✓ | ✓ | - | ✓ | - |
23+
| [Hosted Pages](https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#list_hosted_pages) | ✓ | ✓ | ✓ | - | - |
24+
| [Invoices](https://apidocs.chargebee.com/docs/api/invoices?prod_cat_ver=2#list_invoices) | ✓ | ✓ | ✓ | - | - |
25+
| [Item Families](https://apidocs.chargebee.com/docs/api/item_families?prod_cat_ver=2#list_item_families) | - | ✓ | ✓ | - | - |
26+
| [Item Prices](https://apidocs.chargebee.com/docs/api/item_prices?prod_cat_ver=2#list_item_prices) | - | ✓ | ✓ | - | - |
27+
| [Items](https://apidocs.chargebee.com/docs/api/items?prod_cat_ver=2#list_items) | - | ✓ | ✓ | - | - |
28+
| [Orders](https://apidocs.chargebee.com/docs/api/orders?prod_cat_ver=2#list_orders) | ✓ | ✓ | ✓ | - | - |
29+
| [Payment Sources](https://apidocs.chargebee.com/docs/api/payment_sources?prod_cat_ver=2#list_payment_sources) | ✓ | ✓ | ✓ | - | - |
30+
| [Plans](https://apidocs.chargebee.com/docs/api/plans?prod_cat_ver=1#list_plans) | ✓ | - | ✓ | - | - |
31+
| [Promotional Credits](https://apidocs.chargebee.com/docs/api/promotional_credits?prod_cat_ver=2#list_promotional_credits) | ✓ | ✓ | ✓ | - | - |
32+
| [Quote Line Groups](https://apidocs.chargebee.com/docs/api/quote_line_groups?prod_cat_ver=2#list_quote_line_groups) | ✓ | ✓ | - | ✓ | Requires Performance/Enterprise plan |
33+
| [Quotes](https://apidocs.chargebee.com/docs/api/quotes?prod_cat_ver=2#list_quotes) | ✓ | ✓ | ✓ | - | Requires Performance/Enterprise plan |
34+
| [Site Migration Details](https://apidocs.chargebee.com/docs/api/site_migration_details?prod_cat_ver=2#export_site_migration_detail) | ✓ | ✓ | - | ✓ | - |
35+
| [Subscriptions](https://apidocs.chargebee.com/docs/api/subscriptions?prod_cat_ver=2#list_subscriptions) | ✓ | ✓ | ✓ | - | - |
36+
| [Subscriptions with Scheduled Changes](https://apidocs.chargebee.com/docs/api/subscriptions?prod_cat_ver=2#retrieve_with_scheduled_changes) | ✓ | ✓ | - | ✓ | Associated with Subscriptions |
37+
| [Transactions](https://apidocs.chargebee.com/docs/api/transactions?prod_cat_ver=2#list_transactions) | ✓ | ✓ | ✓ | - | - |
38+
| [Unbilled Charges](https://apidocs.chargebee.com/docs/api/unbilled_charges?prod_cat_ver=2#list_unbilled_charges) | ✓ | ✓ | - | ✓ | - |
39+
| [Virtual Bank Accounts](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts?prod_cat_ver=2#list_virtual_bank_accounts) | ✓ | ✓ | ✓ | - | - |
40+
41+
## Prerequisites
42+
43+
To set up the Chargebee Native source connector, you'll need:
44+
* A Chargebee API key
45+
* Your Chargebee site name
46+
* Your Product Catalog version (1.0 or 2.0)
47+
48+
## Configuration
49+
50+
You can configure the connector either in the Flow web app or by directly editing the catalog specification file.
51+
See [connectors](../../../concepts/connectors.md#using-connectors) to learn more about using connectors. The values and specification sample below provide configuration details specific to the Chargebee Native source connector.
52+
53+
### Properties
54+
55+
#### Endpoint
56+
57+
| Property | Title | Description | Type | Required/Default |
58+
| -------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------- | ------ | ---------------------- |
59+
| `/credentials/api_key` | API Key | Chargebee API Key for authentication. | string | Required |
60+
| `/credentials/credentials_title` | Credentials Title | Name of the credentials set. | string | Required, `"API Key"` |
61+
| `/site` | Site | The site prefix for your Chargebee instance (e.g., 'mycompany' for 'mycompany.chargebee.com'). | string | Required |
62+
| `/start_date` | Start Date | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | string | Required, `30 day ago` |
63+
| `/product_catalog` | Product Catalog | Product Catalog version of your Chargebee site (1.0 or 2.0). | string | Required, `1.0` |
64+
65+
#### Bindings
66+
67+
| Property | Title | Description | Type | Required/Default |
68+
| --------------- | ------------- | ------------------------------------------------------------- | ------ | ---------------- |
69+
| **`/name`** | Resource Name | Name of the Chargebee resource to capture. | string | Required |
70+
| **`/interval`** | Sync Interval | Interval between data syncs (e.g., PT2M for every 2 minutes). | string | |
71+
72+
### Sample
73+
74+
```yaml
75+
captures:
76+
${PREFIX}/${CAPTURE_NAME}:
77+
endpoint:
78+
connector:
79+
image: ghcr.io/estuary/source-chargebee-native:dev
80+
config:
81+
credentials:
82+
credentials_title: API Key
83+
api_key: <secret>
84+
site: mycompany
85+
start_date: "2024-01-01T00:00:00Z"
86+
product_catalog: "2.0"
87+
bindings:
88+
- resource:
89+
name: customers
90+
target: ${PREFIX}/customers
91+
- resource:
92+
name: subscriptions
93+
target: ${PREFIX}/subscriptions
94+
```
95+
96+
## Resource Notes
97+
98+
* Some resources (Quotes and Quote Line Groups) require a Performance or Enterprise Chargebee subscription plan.

‎site/docs/reference/Connectors/capture-connectors/chargebee.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
# Chargebee
1+
# Chargebee (deprecated)
32

43
This connector captures data from Chargebee into Flow collections.
54

0 commit comments

Comments
 (0)