Chargebee integration

Browsertolt.js + Chargebee.js

Chargebeebilling

Toltattribution

1?ref=sam

2cf_tolt_referral: clk_3nVb…

3payment_succeeded

4comm_2nV8… 1470

Set up

Connect Chargebee

In the dashboard, go to Settings → Integrations → Chargebee. Enter your Chargebee site (acme.chargebee.com) and a Chargebee API key, then save. The Chargebee integration page in Tolt

Add tolt.js

Add the script to every page of your site and app. See Install tolt.js.

HTML

<script
  async
  src="https://cdn.tolt.io/v2/tolt.js"
  data-tolt="YOUR_PUBLIC_ORG_KEY"
></script>

Pass the referral to Chargebee

Store the referral on the Chargebee customer. Pick the path that matches your checkout.

Drop-in checkout
API

In Chargebee, go to Settings → Configure Chargebee → Custom Fields and add a customer field with the API name cf_tolt_referral. Then set it on the cart when the buyer starts checkout:

Chargebee.js

async function startCheckout() {
  // Waits for the recorded click. Undefined when the
  // visitor wasn't referred.
  const referral = (await window.tolt?.ready())?.click_id;
  if (referral) {
    const cart = Chargebee.getInstance().getCart();
    cart.setCustomer({ cf_tolt_referral: referral });
  }
  // ...then open the checkout
}

Creating customers from your server? Send window.tolt_referral from the browser and add it to meta_data:

import Chargebee from "chargebee";

const chargebee = new Chargebee({
  site: "acme",
  apiKey: process.env.CHARGEBEE_API_KEY!,
});

const { customer } = await chargebee.customer.create({
  email: "jane@example.com",
  meta_data: { tolt_referral: referral },
});

curl https://acme.chargebee.com/api/v2/customers \
  -u "$CHARGEBEE_API_KEY:" \
  -d email="jane@example.com" \
  --data-urlencode 'meta_data={"tolt_referral":"REFERRAL_ID"}'

Add the webhook

Copy the webhook URL from the Chargebee integration page in the Tolt dashboard. In Chargebee, go to Settings → Configure Chargebee → Webhooks → Add Webhook, paste it and select these events:Subscription Created, Subscription Started, Subscription Cancelled, Subscription Deleted, Payment Succeeded, Payment Refunded, Coupon DeletedAlso turn on Exclude card information from webhook call.

Test it

Open a partner link like acme.com/?ref=sam, complete a checkout, then find the customer under Customers and the commission under Commissions in the dashboard.

With Chargebee connected, Tolt records payments for you. Don’t also call POST /v2/transactions for the same payments, or commissions double count.

Details

Excluding tax

Turn on Exclude Chargebee tax in the tracking amount on the Chargebee integration page. Commissions then use the amount before tax. It’s off by default.

Refunds and cancellations

A refunded payment zeroes unpaid commissions or creates a negative one if already paid. A cancelled or deleted subscription marks the customer canceled. See Refunds.

Get started

Track conversions

Integrations

Concepts

Run your program

Guides

Chargebee integration

Set up

Details

​Set up

​Details

Set up

Details