For the complete documentation index, see llms.txt. This page is also available as Markdown.

Chargebee

Chargebee is a subscription billing and revenue management platform used by SaaS, ecommerce, and recurring-revenue businesses. It handles everything from subscriptions and invoices to coupons and customer data in one place.

Connecting Chargebee to Coupler.io lets you pull your billing and subscription data into any destination — spreadsheets, BI tools, or AI assistants — without writing a single line of code.

Why connect Chargebee to Coupler.io?

  • Centralize subscription, invoice, and transaction data in Google Sheets, BigQuery, Looker Studio, or AI tools like ChatGPT, Claude, or Gemini

  • Combine multiple Chargebee entities (e.g., join Subscriptions with Customers) using Coupler.io's Join transformation

  • Append data from multiple Chargebee sites into a single dataset

  • Keep your reports up to date with scheduled data refreshes

Prerequisites

Before you start, make sure you have:

  • A Chargebee account (any plan)

  • A Chargebee API key — you can find this in your Chargebee dashboard under Settings > Configure Chargebee > API Keys

  • Your Chargebee site name (the subdomain in your Chargebee URL, e.g., yoursite from yoursite.chargebee.com)

Quick start

1

Create a new data flow in Coupler.io. Go to your Coupler.io dashboard and click Add data flow. Search for and select Chargebee as your source.

2

Enter your Chargebee credentials. Paste your API key and enter your Chargebee site name. Coupler.io will use these to authenticate with your account.

3

Select an entity. Choose which Chargebee entity you want to export — for example, Subscriptions, Invoices, or Customers. You can add more sources to the same data flow later.

4

Set a start date. Use the date picker to define how far back Coupler.io should pull data. Records created before this date will not be included.

5

Choose a destination. Select where you want your data to land — Google Sheets, Excel, BigQuery, Looker Studio, or an AI destination like ChatGPT, Claude, or Gemini.

6

Run the data flow. Click Run to perform a manual sync. Once it completes successfully, your Chargebee data will appear in your chosen destination.

Available entities

Entity
What it contains

Subscriptions

Active and historical subscription records

Subscription with scheduled changes

Subscriptions with pending future changes

Customers

Customer profiles and metadata

Invoices

Invoice details, amounts, and statuses

Transactions

Payment transactions and outcomes

Credit notes

Issued credit notes against invoices

Unbilled charges

Charges not yet added to an invoice

Orders

Physical/digital order records

Items

Product catalog items

Item prices

Pricing details per item

Item families

Groupings of related items

Attached items

Items linked to plans or subscriptions

Plans

Subscription plan definitions

Addons

Add-on product definitions

Coupons

Discount coupon records

Promotional credits

Promotional credit balances

Payment sources

Saved payment methods

Contacts

Billing/account contacts

Events

Audit log of Chargebee events

Hosted pages

Checkout and portal page records

Quotes

Sales quotes

Quote line groups

Line item groups within quotes

Gifts

Gift subscription records

Virtual bank accounts

Virtual bank account details

Differential prices

Price overrides for specific customers

Comments

Internal comments on records

Site migration details

Data from site migrations

Chargebee data overview

Chargebee exposes a wide range of subscription billing data through Coupler.io. You can export everything from customer profiles and subscription lifecycles to individual transactions, pricing catalogs, and audit events.

Available entities

Entity
Best used for

Subscriptions

MRR tracking, churn analysis, lifecycle reporting

Customers

Segmentation, cohort analysis

Invoices

Revenue recognition, accounts receivable

Transactions

Payment success/failure rates, cash flow

Credit notes

Refund tracking, adjustments

Unbilled charges

Pending revenue, billing cycle forecasting

Plans & Items

Pricing catalog analysis

Coupons & Promotional credits

Discount usage and impact

Events

Audit trail, integration debugging

Quotes

Sales pipeline, pre-billing activity

Key fields by entity

Subscriptions

Field
Description

id

Unique subscription ID

customer_id

Linked customer

plan_id

Associated plan

status

active, cancelled, paused, etc.

current_term_start / current_term_end

Current billing period

mrr

Monthly recurring revenue for this subscription

created_at

Subscription creation timestamp

cancelled_at

Cancellation timestamp (if applicable)

currency_code

Billing currency

Customers

Field
Description

id

Unique customer ID

email

Customer email

company

Company name

billing_address

Full billing address

taxability

Tax status

created_at

Account creation timestamp

Invoices

Field
Description

id

Invoice ID

customer_id

Linked customer

subscription_id

Linked subscription

status

paid, posted, payment_due, voided

amount_due

Outstanding balance

amount_paid

Amount collected

total

Invoice total

date

Invoice date

currency_code

Billing currency

Transactions

Field
Description

id

Transaction ID

customer_id

Linked customer

subscription_id

Linked subscription

amount

Transaction amount

status

success, failure, voided

payment_method

Payment method type

date

Transaction date

Plans & Item prices

Field
Description

id

Plan or item price ID

name

Display name

price

Price in smallest currency unit

period / period_unit

Billing frequency

status

active, archived

currency_code

Currency

Common metric combinations

  • MRR by plan: Join Subscriptions + Plans on plan_id to break down recurring revenue by product tier

  • Revenue vs. refunds: Join Invoices + Credit notes on customer_id to compare billed vs. returned amounts

  • Payment failure rate: Use Transactions filtered by status = failure against total transaction count

  • Churn cohorts: Use Subscriptions with cancelled_at and created_at to build monthly cohort churn tables

  • Discount impact: Join Invoices + Coupons to measure revenue lost to discounts

Use cases by role

  • Pull Invoices and Transactions into Google Sheets or BigQuery to automate revenue recognition

  • Use Unbilled charges to forecast upcoming billing cycle totals

  • Combine Credit notes with Invoices to reconcile net revenue

  • Send invoice summaries to ChatGPT or Claude for automated narrative reporting

  • Analyze Coupons and Promotional credits to measure discount campaign ROI

  • Segment Customers by plan or acquisition date to build targeted outreach lists

  • Track Subscription upgrades and downgrades to identify expansion revenue trends

  • Monitor Events for unusual activity or integration issues

  • Use Subscriptions with scheduled changes to anticipate upcoming plan transitions

  • Pull Hosted pages data to analyze checkout conversion patterns

  • Join Items + Item prices to audit your pricing catalog across currencies

Platform-specific notes

  • Chargebee uses cents (or the smallest currency unit) for monetary fields — divide by 100 to get standard decimal values in your destination

  • The status field on Subscriptions uses Chargebee's native values: active, in_trial, cancelled, paused, future, non_renewing

  • The Events entity is useful for debugging webhook failures but can be high-volume — set a specific start date to avoid pulling unnecessary history

  • If you use Chargebee's Product Catalog v2, use Items, Item prices, and Item families instead of the legacy Plans and Addons entities

  • Timestamps in Chargebee are returned as Unix epoch integers — most BI tools will need a conversion step

Chargebee common issues

Connection issues

"Internal error encountered" when running the data flow

This is usually caused by an invalid API key, incorrect site name, or a permission mismatch. Double-check the following:

  • Your API key is copied in full with no extra spaces

  • Your Chargebee site name matches the subdomain exactly (e.g., yoursite not yoursite.chargebee.com)

  • The API key has read access to the entities you're trying to export

If everything looks correct, try regenerating a new API key in Chargebee under Settings > Configure Chargebee > API Keys and reconnecting.

Authentication fails after previously working

Chargebee API keys can be manually revoked or rotated. Check your Chargebee dashboard to confirm the key is still active. If it was deleted, generate a new one and update your data flow's source credentials.

Missing data

No data returned even though records exist in Chargebee

Check the start date you set in the data flow. If the start date is set too recently, records created before that date won't be included. Try setting an earlier start date to pull historical data.

Subscriptions or invoices are missing from the export

Some entities have dependencies. For example, invoices linked to deleted customers may not export cleanly. Also confirm the entity you selected matches the Chargebee Product Catalog version you're using — if you're on Product Catalog v2, use Items and Item prices rather than Plans and Addons.

Permission errors

"Access denied" or 403 error for specific entities

Not all API keys have access to all endpoints. In Chargebee, API keys can be scoped to read-only or restricted to specific resources. Go to Settings > Configure Chargebee > API Keys and verify the key has full read access, or create a new key with the required permissions.

Data discrepancies

Monetary values look incorrect (e.g., $4999 instead of $49.99)

Chargebee stores all monetary amounts in the smallest currency unit (cents for USD). You'll need to divide by 100 in your destination to get standard decimal values. In Google Sheets, you can add a calculated column; in BigQuery, apply the conversion in a view.

Timestamps look like large numbers instead of dates

Chargebee returns timestamps as Unix epoch integers (seconds since January 1, 1970). Use your destination's date conversion function to transform them — for example, in Google Sheets use =(A1/86400)+DATE(1970,1,1), and in BigQuery use TIMESTAMP_SECONDS().

Rate limits

Data flow times out or slows down on large exports

Chargebee enforces API rate limits that vary by plan. If you're exporting high-volume entities like Events or Transactions without a start date filter, you may hit these limits. Set a specific start date to limit the data volume, especially for the first run.

Chargebee FAQ

Where do I find my Chargebee API key?

Log into your Chargebee dashboard and go to Settings > Configure Chargebee > API Keys & Webhooks. You'll see existing keys listed there. Click Add API Key to create a new one. For Coupler.io, a read-only key is sufficient and recommended.

What is the Chargebee site name and where do I find it?

Your site name is the subdomain in your Chargebee URL. For example, if your Chargebee dashboard is at acme-test.chargebee.com, your site name is acme-test. Enter only the subdomain — not the full URL.

Can I export data from multiple Chargebee sites?

Yes. Create a data flow with sources pointing to each site using separate API keys. Use Coupler.io's Append transformation to combine data from both sites into a single dataset, with a column to distinguish which site each record came from.

Why are my revenue numbers 100x too large?

Chargebee stores all monetary values in the smallest currency unit (cents for USD/EUR). Divide those fields by 100 to get standard decimal amounts. Apply this conversion in your destination — for example, as a calculated column in Google Sheets or a transformation in BigQuery.

Why do dates appear as large numbers instead of readable dates?

Chargebee returns timestamps as Unix epoch integers. You'll need to convert them in your destination. In Google Sheets, use =(A1/86400)+DATE(1970,1,1). In BigQuery, use TIMESTAMP_SECONDS(field_name).

Should I use Plans/Addons or Items/Item prices?

It depends on which version of Chargebee's Product Catalog your account uses. If you created your Chargebee account recently or have migrated, you're likely on Product Catalog v2 — use Items, Item prices, and Item families. Legacy accounts use Plans and Addons. Mixing entities from both versions in the same report will cause mismatches.

Can I use Chargebee data with AI tools?

Yes. Coupler.io supports AI destinations including ChatGPT, Claude, Gemini, Cursor, Perplexity, and OpenClaw. You can send Chargebee subscription or invoice data directly to these tools for automated analysis, narrative summaries, or anomaly detection.

My data flow keeps failing with an internal error — what should I check?

Start by verifying your API key is valid and hasn't been revoked in Chargebee. Also confirm your site name is correct (subdomain only, no .chargebee.com). If credentials look right, try creating a fresh API key in Chargebee and updating your data flow. See the Common Issues article for more detail.

For details on available fields and how to combine entities, see the Data Overview article. For troubleshooting sync failures, visit Common Issues. For setup recommendations, check Best Practices.

Last updated

Was this helpful?