Connectors / Service / Chargebee

Chargebee provides subscription and recurring billing solutions for subscription-based SaaS and eCommerce businesses. (updated: 1657717613842)

Chargebee

A leading subscription billing software powering end-to-end recurring billing, subscription management & auto invoicing

Overview

Chargebee is the subscription billing and revenue management platform that lets you solve for your today, and scale for your tomorrow.

Authentication

After adding a Chargebee connector, click to add a new authentication:

new-chargebee-auth

You will then be presented with the auth dialog:

chargebee-auth-dialog

When entering your domain be sure to remove the 'https://' prefix and the 'chargebee.com' suffix.

So if your domain is https://koreservices-test.chargebee.com you should enter 'koreservices-test'

Your API key is obtained by going to Configure Chargebee > API Keys and Webhooks in the Chargebee admin UI:

chargebee-api

Setting up a Webhook

In Chargebee it is possible to set up a webhook in order to automatically notify a Tray workflow when events occur in Chargebee.

To do this, create a new workflow in Tray with a Webhook Trigger:

chargebee-choose-webhook-trigger

In your workflow click to enable it.

Then go to 'Workflow settings' in the top-left of the builder.

From here you can copy the 'Workflow public URL':

chargebee-copy-public-url

And then create a new Webhook in Chargebee using the Workflow public URL:

chargebee-create-webhook

Note that you can also choose which events to send.

You can then test your webhook URL:

chargebee-test-url

In your Tray workflow debug panel you will then see a test webhook payload coming through (don't forget your workflow needs to be enables otherwise it won't work!):

chargebee-webhook-debug

From here you can then use jsonpaths such as $.steps.trigger.body.content.customer.id and $.steps.trigger.body.content.customer.email to grab individual pieces of data from the webhook and pass into other connectors.

For more information please see our Intro to jsonpaths and working with data and jsonpaths

All Operations

Latest version:

1.1

Create customer

Create a new customer.

Create order

Create a new order. NOTE: This operation can only be used if you are using Chargebee's legacy order management system.

Get customer

Retrieve a specific customer.

Get event

Retrieve a specific event.

Get order

Retrieve a specific order.

Get subscription

Retrieve a specific subscription.

Get transaction

Retrieve a specific transaction.

List customers

Retrieve a list of customers.

List customers DDL

List events

Retrieve a list of events.

List events DDL

List orders

Retrieve a list of orders.

List orders DDL

List subscriptions

Retrieve a list of subscriptions.

List subscriptions DDL

List transactions

Retrieve a list of transactions.

List transactions DDL

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Update customer

Update an existing customer.