Skip to content

Connect your app to Chargebee

Connect your app to Chargebee, a subscription billing and revenue management platform, to manage customers, subscriptions, invoices, checkout, and billing workflows.

Updated View as Markdown

Chargebee is a subscription billing and revenue management platform for managing customers, subscriptions, invoices, payments, product catalog data, hosted checkout, and billing portal flows. The Chargebee connector lets your RShift Sites app call the Chargebee API through a workspace-level connection.

Chargebee is available as an app + chat connector: one shared connection that works in the project chat while you build and in your published apps.

With Chargebee, your app can:

  • List and manage customers and subscriptions
  • Read invoices, credit notes, payments, and orders
  • Build billing workflows around products and item prices
  • Create hosted checkout pages and billing portal flows

The Chargebee connector is a good fit when your app needs subscription billing data, customer billing workflows, or internal tools backed by your Chargebee account.

Common use cases and example apps

Example app Example prompt Description
Customer billing portal Use Chargebee and build a customer billing portal where customers can view their subscription, invoices, and payment status. Give customers access to billing information from Chargebee.
The app reads customer, subscription, invoice, and payment data from Chargebee and presents it in a self-service portal.
Subscription admin dashboard Use Chargebee and build an admin dashboard for searching customers, viewing subscriptions, and checking invoice status. Help operators manage subscription accounts in one place.
The app lists Chargebee customers and subscriptions so support or finance teams can investigate account status.
Checkout flow Use Chargebee and build a checkout flow that creates hosted checkout pages for subscription plans. Start subscription checkout from your app.
The app creates Chargebee hosted checkout pages and redirects customers to complete subscription signup.
Revenue reporting app Use Chargebee and build a revenue dashboard showing recent invoices, payments, credit notes, and orders. Turn billing activity into operational reporting.
The app reads Chargebee billing records and summarizes recent revenue activity for your team.
Plan management tool Use Chargebee and build an internal tool for reviewing products, item prices, and subscription plan details. Surface product catalog data from Chargebee.
The app reads Chargebee product and price data so teams can inspect plans without leaving the app.
Renewal workflow tracker Use Chargebee and build a workflow tracker for upcoming subscription renewals and failed payments. Track billing events that need follow-up.
The app uses Chargebee subscription and payment data to highlight accounts that need attention.

How to connect Chargebee

Workspace admins and owners can connect Chargebee.

You can create multiple Chargebee connections using different API keys, which is useful for separating environments (for example, test and production) or connecting different Chargebee sites.

When the connection is created, Chargebee becomes available across all projects in the workspace. Anyone building in a project can ask RShift Sites in the project chat to link their project to it.

Prerequisites

Before connecting Chargebee, make sure you have:

  • A Chargebee account
  • Your Chargebee site name, for example acme-test from https://acme-test.chargebee.com
  • A Chargebee API key
  • RShift Sites workspace owner or admin role

Step 1: Get your Chargebee site name and API key

A Chargebee API key lets your RShift Sites app authenticate with the Chargebee API for your connected site. You can create separate keys for different environments or apps.

To find your site name and create a Chargebee API key:

Open your Chargebee site

Sign in to Chargebee with the account for the site you want to connect.

Note your site name

Copy the site name from your Chargebee URL. For example, if your Chargebee URL is https://acme-test.chargebee.com, enter acme-test in RShift Sites.

Open API keys

Follow Chargebee’s API key instructions to open the API keys area for your site.

Create or copy an API key

Create a key for RShift Sites or copy an existing key with permissions for the Chargebee API actions your app needs. Use a descriptive name, for example RShift Sites integration.

Copy the key

Copy the API key and store it securely.

See Chargebee documentation for more: Chargebee API getting started.

Step 2: Connect Chargebee to RShift Sites

You can create multiple connections using different API keys.

Open Chargebee in Connectors

Go to Connectors and select Chargebee.

Add a connection

Click Add connection.

Configure the connection

  • Display name: name the connection, for example Chargebee Prod or Chargebee Test.
    • Site name: enter your Chargebee site name without .chargebee.com, for example acme-test.
    • API key: paste your Chargebee API key.

Choose who can use this connection

Under Sharing, the connection is private to you by default and shows a Private label. To share it, click Share with others. Then add workspace members by email, or click Invite entire workspace to make the connection available to everyone in your RShift Sites workspace.

See Who can use connections and clients for more information.

Connect

Click Connect.

When connected, anyone building in a project can ask RShift Sites in the project chat to link their project to Chargebee (based on configured connection-level access). Your RShift Sites apps can then manage customers, subscriptions, invoices, checkout, and billing workflows through Chargebee.

Limitations

The Chargebee connector cannot:

  • Create or manage your Chargebee account or site configuration
  • Receive Chargebee webhooks directly through the connector
  • Rotate API keys automatically. To rotate a key, create a new key in Chargebee and update the RShift Sites connection
  • Support per-end-user Chargebee login. Each connection represents a single Chargebee account shared across all projects linked to it
  • Bypass Chargebee API permissions, limits, or billing rules for your account

Manage your {connector_0} connection

Connections are managed from Connectors: select {connector_0}, then open the connection.

  • Unlink projects to remove {connector_0} access from specific projects while keeping the connection available for others. See Unlink projects from a connection for the steps.
  • Delete the connection to remove it from the workspace entirely. Deleting is permanent. It removes the credentials from all linked projects, and app features that use {connector_0} stop working until a new connection is added. See Delete a connection for the steps and who can delete.
Navigation

Search for a question, a feature, or a task.

↑↓ to navigate↵ to openEsc to close