Chargebee Billing Integration

Brightback's native integration with Chargebee makes it easy for you to retain subscribers and revenue by reducing voluntary churn. By connecting Brightback to Chargeebee, you will be able to enable three of our four main billing integration use cases (note we don't yet support Attribution for Chargebee but will be adding). 

  • Enrichment - map fields from the Chargebee subscription record to personalize your experiences, build custom Audiences for user targeting purposes   
  • Manage offers - directly pause, discount, extend, and update a subscription in Chargebee based on Chargebee Subscription ID when a customer accepts a Brightback offer
  • Manage cancels - directly cancel a subscription in Chargebee when a user completes the cancel request, which can be configured to: include all active subscriptions on a Chargebee Account record, to invoice users immediately for all outstanding charges, or to Prorate the subscription. 
  • Attribution (coming soon) - this validates a Brightback Save event by confirming a subscription is still valid when the Save event fires, then retrieving revenue values to calculate and apply revenue to your Brightback dashboards and reports

These use cases are core to Brightback and allow you to perform some of the key elements of your cancel flow, including:

  • Pull subscription data from Chargebee into Brightback to enrich the profile of your customer for using in targeting custom audiences, personalizing the cancel experience, and segmenting data records to build richer save and churn reports
  • Process cancels and offers directly to billing, either using Brightback Webhooks, pass-thru URLs, or by posting changes directly to the subscription via the Brightback Integration (currently in Beta) 

Connecting Brightback to Chargebee

In order for the Chargebee integration to work, you must first connect your Chargebee account to Brightback via our integrations page. You will want to pick a read/write API key if you plan to utilize the Manage Cancel feature to update subscriptions. You will also need to ensure you pass the Chargebee Subscription ID for that subscription via the Brightback JS. 

This ChargeBee Subscription ID is captured dynamically from the brightback.js code snippet (or from your Salesforce CRM account) when the user first initiates a session by clicking to cancel. If you haven't already, review the documentation on how to install the brightback javascript snippet

Enriching your subscription profile  

Once Chargebee is connected, you can leverage Brightback's enrichment feature to reduce the engineering time and effort needed to install the Brightback.js snippet. With the integration enabled, Brightback will use the Chargebee Subscription ID to lookup and key subscriber data in Chargebee (such as first purchase date or billing frequency), and sync it back into Brightback to map to Brightback fields using Field Mappings located under 'Settings' (read below).  

Syncing and mapping Chargebee fields into Brightback

Before you can successfully map Chargebee data into Brightback, you must first ensure that you are capturing the Chargebee sub id via the Brightback.js, and have mapped this field to the Subscription ID in the field mappings page. 

Once successfully connected to Chargebee, navigate to 'Field mappings' under Settings, to start mapping. For each Brightback field that you will map to, you must first specify the field data type (e.g. text, date, decimal, email, URL), then select the source field in Chargebee, visible under the Chargebee source in the menu dropdown. 

Go ahead and map as many fields as you would like. Mapped fields can be used to personalize the cancel page, target the cancel experience/offers, and in reporting via the customer's page. 

Example Chargebee payload

"integration_type" : "BILLING",
  "data_type" : "CHARGEBEE",
  "display_name" : "Chargebee",
  "objects" : [ {
    "requires_external_id" : false,
    "fields" : [ {
      "name" : "subscription.id",
      "label" : "Subscription Id",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.created_at",
      "label" : "Subscription Create Date",
      "type" : "date",
      "maps_to_type" : [ "date" ]
    }, {
      "name" : "subscription.activated_at",
      "label" : "Subscription Activation Date",
      "type" : "date",
      "maps_to_type" : [ "date" ]
    }, {
      "name" : "subscription.billing_period",
      "label" : "Billing Period",
      "type" : "integer",
      "maps_to_type" : [ "integer" ]
    }, {
      "name" : "subscription.billing_period_unit",
      "label" : "Billing Period Unit",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.started_at",
      "label" : "Subscription Start Date",
      "type" : "date",
      "maps_to_type" : [ "date" ]
    }, {
      "name" : "subscription.mrr",
      "label" : "Subscription MRR",
      "type" : "decimal",
      "maps_to_type" : [ "decimal" ]
    }, {
      "name" : "subscription.customer.id",
      "label" : "Customer Id",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.customer.first_name",
      "label" : "Customer First Name",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.customer.last_name",
      "label" : "Customer Last Name",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.customer.company_name",
      "label" : "Customer Company Name",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.customer.email",
      "label" : "Customer Email",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.customer.created_at",
      "label" : "Customer Create Date",
      "type" : "date",
      "maps_to_type" : [ "date" ]
    }, {
      "name" : "subscription.plan_id",
      "label" : "Plan Id",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.plan_amount",
      "label" : "Plan Amount",
      "type" : "decimal",
      "maps_to_type" : [ "decimal" ]
    }, {
      "name" : "subscription.plan_quantity",
      "label" : "Plan Quantity",
      "type" : "text",
      "maps_to_type" : [ "text" ]
    }, {
      "name" : "subscription.plan_unit_price",
      "label" : "Plan Unit Price",
      "type" : "integer",
      "maps_to_type" : [ "integer" ]
    } ]
  } ]
}<br>

Missing a field? Please contact support@brightback.com and we'll look into adding it. 

Processing Cancels in Chargebee

When a user completes a cancel on the Brightback page, we will update Chargebee to mark the subscription as canceled. This process works as follows: 

  • Cancel the matching Chargebee Subscription ID via the Chargebee integration. When a customer submits a valid cancel request via your Brightback page, Brightback cancels the matching Chargebee Subscription ID. Confirm by navigating to Customers | Subscriptions in Chargebee, and confirming that the customers' subscription is pending cancellation. 

You can choose how to apply the cancel in Chargebee under the Setup tab for the integration. 

Select the options that match how you currently handle cancellations in Chargebee and hit Save & Close. 

Processing Offers in Chargebee

We support the ability for you to map Discounts, Pauses, Extensions, and Plan Changes directly to Chargebee Subscriptions. When the user selects one of these Offers in the cancel flow, we will apply it directly to the corresponding Subscription in Chargebee. To get started with Offer Management, go ahead and enable this toggle on the Settings page. 

Next, create a "Discount" type offer in Brightback, where you will finalize the offer content, button copy, and define where the offer appears on your Brightback page ("Placement"). 

Finally, you will use the "Billing" sidebar to browse and select the Billing coupon created above in Chargebee, is applied to your customers' subscription when they accepts this offer!  

  • Pause a Chargebee subscription: to automatically pause a Chargebee subscription, you will first create a new Pause offer in Brightback, per the steps above, this time selecting the "Pause" offer type. However, when configuring billing, you will now have the option to define a pause duration, based on the pause Duration and Interval (below). An example here might be to test a 2 month Pause of your product/service, targeting customers who do not intend to use it for a period of time (e.g. are going on vacation or project has delayed).  

  • Change a Chargebee Plan: to automatically change a Chargebee subscription, create a new "Plan Change" offer in Brightback, per the steps above. When configuring billing, simply select a plan from the available list in the dropdown, which will be automatically updated upon offer user accepts this offer type.   

  • Extend a Chargebee Plan: to automatically extend a Chargebee subscription, create a new "Extension" offer type in Brightback, per the steps above. When configuring billing, simply select the Duration and the Interval from the available list in the Extension dropdown. An example here might be to offer an extended trial of your product/service, such that your customer still retains full use and control over their account. 

Validate Saves and Attribute Revenue with Attribution 

The Attribution integration enables Brightback to cross-check your billing system to validate any Brightback Saved or Watch List customers haven't canceled or let their accounts lapse in other ways beyond Brightback, and calculate the dollar amount in revenue saved (or lost) per customer that hits your Brightback Page. 

We currently do not support Attribution for Chargrebee, but we do have it on our roadmap to build. If you would like Attribution support for Chargebee, email support@brightback.com and it will help us prioritize this! 

Processing customized Cancels and Saves in Chargebee

If your Chargebee account is not configured properly, or you don't use Chargebee to manage subscriptions, you may alternatively automatically cancel or modify your subscriptions using Brightback's webhooks or pass through URLs (which requires some engineering to set up), as follows:  

  • Brightback Webhooks - when a customer cancels or accepts an offer (e.g. 1 free month, pause, etc.), then Brightback's Webhook event URL triggers an action in Chargebee. Note: you would need to have already set up a Coupon in Chargebee, then the Brightback webhook will apply the coupon to the actual customer. 
  • Pass Thru URLs -  when a customer cancels or accepts an offer (e.g. 1 free month) then Brightback calls a URL, that can trigger an in-biling action (e.g. https://netflix.com/free-month?customer_id=12345&interval=1).

Need a Brightback developer sandbox for testing the integration with a Chargebee dev account? Please contact support@brightback.com or your account manager, who can promptly set up your developer account.  

Install your snippet and send cancel sessions to Brightback

The final step to using our Recurly integration is to send cancel sessions to Brightback with the unique subscription id populated dynamically in the snippet. Below is an example of the minimum properties you would need to send in order to create unique cancel sessions. 

<a id="bb-cancel" href="/fallback">Cancel</a>
<script
  type="text/javascript"
  src="https://app.brightback.com/js/current/?compiled=true"
></script>
<script type="text/javascript">
  if (window.Brightback) {
    window.Brightback.handleData({
      app_id: "APP_ID", //your Brightback APP_ID
      subscription_id: "AzZm24SaSGHEK1tFn", //dynamically populated Recurly subscription id
    });
  }
</script>

You of course can send other properties like usage activity in a custom object for personalization and targeting.  For more info on that or other installation options check out our full article on installing Brightback.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us