Chargebee Time Machines Python API Docs | dltHub

Chargebee is a subscription billing and revenue management platform that provides a REST API for managing customers, subscriptions, and simulation tools like Time Machines. The REST API base URL is https://{site}.chargebee.com/api/v2 and all requests use HTTP Basic authentication with the API key as the username and an empty password.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Chargebee Time Machines data in under 10 minutes.

---

What data can I load from Chargebee Time Machines?

Here are some of the endpoints you can load from Chargebee Time Machines:

---

How do I authenticate with the Chargebee Time Machines API?

Chargebee uses HTTP Basic authentication. The API key acts as the username, and the password field must be left empty.

1. Get your credentials

1. Log in to your Chargebee dashboard.
2. Navigate to Settings > Configure Chargebee > API Keys and Webhooks.
3. Select the API Keys tab.
4. Click + Add API Key to generate a new key.
5. Choose the appropriate key type (e.g., Full-Access Key for most integrations).
6. Copy the generated API key securely, as it will be used as the username in HTTP Basic Authentication (leave the password field empty).

2. Add them to .dlt/secrets.toml

Copy
[sources.chargebee_time_machines_source]
api_key = "your_full_access_api_key_here"
site_name = "your_chargebee_site_name"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Chargebee Time Machines API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
uv run python chargebee_time_machines_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline chargebee_time_machines_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset chargebee_time_machines_data
The duckdb destination used duckdb:/chargebee_time_machines.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads customers and subscriptions from the Chargebee Time Machines API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

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

@dlt.source
def chargebee_time_machines_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 get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="chargebee_time_machines_pipeline",
        destination="duckdb",
        dataset_name="chargebee_time_machines_data",
    )
    load_info = pipeline.run(chargebee_time_machines_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("chargebee_time_machines_pipeline").dataset()
sessions_df = data.time_machines.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM chargebee_time_machines_data.time_machines LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("chargebee_time_machines_pipeline").dataset()
data.time_machines.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Chargebee Time Machines data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack