Load Chargebee data to Dremio

Chargebee is a subscription billing platform that provides a REST API for managing subscriptions, customers, invoices, and payments. Everything needed to build a working Chargebee → Dremio pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your Chargebee to Dremio pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Chargebee API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

Chargebee API at a glance

These values come from the Chargebee API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the Chargebee API?

Chargebee uses HTTP Basic authentication. You must provide your API key as the username and leave the password empty, typically handled via the Authorization header using the base64-encoded string 'api_key:'.

1. Get your credentials

To obtain your Chargebee API credentials, log in to your Chargebee application and navigate to Settings > Configure Chargebee > API Keys and Webhooks. Click on the API Keys tab, select Add an API Key, choose Full-Access Key (recommended for integration), provide a name, and save the key securely. Ensure you use the appropriate test or live site API key for your environment.

2. Add them to .dlt/secrets.toml

Copy
[sources.chargebee_source]
api_key = "your_api_key_here"
site_name = "your_site_name_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What Chargebee data can I load into Dremio?

These are the Chargebee endpoints dlt can load into Dremio:

---

How do I load only new Chargebee records?

Chargebee exposes updated_at on customers, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

Copy
{"name": "customers", "endpoint": {
    "path": "customers",
    "data_selector": "list",
    "incremental": {"cursor_path": "updated_at", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated Chargebee pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading customers and subscriptions from the Chargebee API into Dremio:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def chargebee_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{site}.chargebee.com/api/v2",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key},
        },
        "resources": [
            {"name": "customers", "endpoint": {"path": "customers", "data_selector": "list"}},
            {"name": "subscriptions", "endpoint": {"path": "subscriptions", "data_selector": "list"}}
        ],
    }
    yield from rest_api_resources(config)


def load_chargebee_to_dremio() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="chargebee_pipeline",
        destination="dremio",
        staging="filesystem",
        dataset_name="chargebee_data",
    )
    load_info = pipeline.run(chargebee_source())
    print(load_info)


if __name__ == "__main__":
    load_chargebee_to_dremio()

Run it with uv run python chargebee_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I configure Dremio as the destination?

Dremio loads from object storage, so dlt first writes the data to an S3 bucket through its filesystem staging destination; that is the staging="filesystem" in the code above. Install the extras with uv add "dlt[dremio,s3]", then add the staging bucket and the Dremio connection to .dlt/secrets.toml:

Copy
[destination.filesystem]
bucket_url = "s3://<staging bucket>"

[destination.filesystem.credentials]
aws_access_key_id = "<access key id>"
aws_secret_access_key = "<secret access key>"

[destination.dremio]
staging_data_source = "<object storage source>"

[destination.dremio.credentials]
host = "<host>"
port = 32010
username = "<user>"
password = "<password or personal access token>"
database = "<data source>"

staging_data_source is the Object Storage source in Dremio that points at the staging bucket, and database is the Dremio source dlt loads into. port is the Arrow Flight port; set drivername = "grpc+tls" for TLS. See the dlt Dremio destination docs.

---

How do I query Chargebee data in Dremio?

After a run, pipeline.dataset() holds the loaded tables, one per resource. A Relation is a query on that dataset, either a whole table or a SQL string, and reading it gives you the data as a Pandas DataFrame, a PyArrow table or Python tuples. Nothing is read until you ask for it.

Copy
import dlt

pipeline = dlt.pipeline("chargebee_pipeline")

# Step 1: Get the dataset from the pipeline
dataset = pipeline.dataset()

# Step 2: Get a Relation, either a whole table...
customers = dataset.table("customers")
# ...or any SQL query against Dremio
sample = dataset("SELECT * FROM customers LIMIT 100")

# Step 3: Read the data
df = customers.df()  # or .df(chunk_size=50) for a large table
arrow_table = sample.arrow()  # a PyArrow Table
rows = sample.fetchall()  # a list of Python tuples

# Which tables were loaded, and how big are they?
print(dataset.row_counts().df())
"""
      table_name  row_count
0      customers         13
1  subscriptions          3
"""

The columns are the fields the Chargebee API returns. Your agent can run the same queries through the MCP server's execute_sql_query tool, and uv run dlthub show opens the Pipeline Dashboard with the schema, load metrics and a query box. See access loaded data in Python and exploring it in marimo notebooks.

---

How do I deploy the Chargebee to Dremio pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw Chargebee loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Chargebee data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack