Creating a Chargebee API Key

Upzelo recommends that you connect Live and Test Chargebee accounts to Upzelo and Upzelo Test modes. The key permissions described below ensure Upzelo has the minimum access level required.

Retrieving the API Key in both Test and Live Chargebee accounts

Navigate to Settings > API Keys and select "Add API Key".

mceclip3.png

Upzelo requires a Full Access Key.

mceclip5.png

With the 'Full-Access Key' option selected, you can specify to create a 'Write key' with all permissions that Upzelo needs to read subscription data and write subscription updates and coupons to your account:

mceclip7.png

Finally, copy the key into Upzelo. You'll also need the Site name, which can be found in the highlighted proportion of your Chargebee portal URL:

mceclip8.png

Setting up Webhooks for real-time sync

Upzelo requires a webhook to be setup in Chargebee so that Subscription changes are kept synchronised in real-time and customer flow outcomes are processed for subscriptions immediately.

Live mode
Fill in your account's app id and copy and Paste the Upzelo webhook configuration into Chargebee > Integrations > Webhooks.

Endpoint Name: Upzelo
Endpoint URL: https://upzelo.com/webhooks/chargebee/0/[Upzelo app id]

Test mode

Fill in your account's app id and copy and Paste the Upzelo webhook configuration into Chargebee > Integrations > Webhooks.

Endpoint Name: Upzelo
Endpoint URL: https://upzelo.com/webhooks/chargebee/1/[Upzelo app id]

Navigate to Settings > Webhooks and click "Add Webhook"

mceclip0.png

Apply your Webhook Name and URL, and set "Exclude card information from webhook call", leave everything else as default.

mceclip2.png
Did this answer your question?