Chargebee

What’s supported

Supported actions

This connector supports:

• Read Actions, including full historic backfill.
• Write Actions.
• Proxy Actions, using the base URL https://{{.workspace}}.chargebee.com/api.

Supported objects

The Chargebee connector supports reading from the following objects:

• attached_items
• business_entities/transfers
• comments
• coupon_codes
• coupon_sets
• coupons
• credit_notes
• currencies
• customers
• entitlements
• events
• features
• gifts
• hosted_pages
• invoices
• item_families
• item_prices
• items
• omnichannel_one_time_orders
• omnichannel_subscriptions
• orders
• payment_sources
• plans
• promotional_credits
• quotes
• subscriptions
• transactions
• unbilled_charges
• usages
• virtual_bank_accounts
• webhook_endpoints

Objects supporting incremental read:

• coupons
• credit_notes
• customers
• hosted_pages
• invoices
• item_prices
• items
• orders
• payment_sources
• quotes
• subscriptions
• transactions
• usages
• virtual_bank_accounts

For all other objects, a full read of the Chargebee instance will be done per scheduled read.

The Chargebee connector supports writing to the following objects:

• comments
• coupons
• coupon_sets
• credit_notes
• currencies
• customers
• estimates
• features
• invoices
• item_families
• item_prices
• items
• offer_events
• offer_fulfillments
• orders
• payment_intents
• payment_schedule_schemes
• payment_vouchers
• portal_sessions
• promotional_credits
• quotes
• recorded_purchases
• transactions
• unbilled_charges
• virtual_bank_accounts
• webhook_endpoints

Example integration

For an example manifest file of a Chargebee integration, visit our samples repo on Github.

Using the connector

This connector uses Basic auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Chargebee:

• Create a manifest file like the example above.
• Deploy it using the amp CLI.
• Embed the InstallIntegration UI component. The UI component will prompt the customer for their username, password and site name.
• Start making Proxy Calls, and Ampersand will automatically attach the correct header required by Basic Auth. Please note that this connector’s base URL is https://{{.site}}.chargebee.com/api.

Creating Basic Auth Credentials for Chargebee

Chargebee uses the API Key as the username when authenticating with Basic Auth. The password field should be left blank.

Click here for more information about generating an API key for Chargebee. The UI components will display this link, so that your users can successfully create API keys.