# Chargebee

> Subscription billing and revenue management with Chargebee. Create and look up customers, and list subscriptions and invoices, straight from your workflows.

App · Payments & Billing · 5 actions. Web page: https://docs.lodol.com/docs/integrations/chargebee

## Actions

### Create a Chargebee customer

Create a new customer record in Chargebee with optional contact details (email, first and last name, company, and phone). The customer is the top-level account that subscriptions and invoices attach to. Useful for onboarding a new signup or syncing a CRM/e-commerce contact into billing. Provide at least one identifying field.

**Inputs**

- Email (`email`, text): Customer email address. Configured email notifications (invoices, receipts, dunning) are sent here.
- First name (`first_name`, text): Customer's first name.
- Last name (`last_name`, text): Customer's last name.
- Company (`company`, text): Company name to associate with the customer.
- Phone (`phone`, text): Customer phone number.

**Outputs**: Chargebee wraps the created record under a 'customer' key. IDs are strings; 'created_at'/'updated_at' are Unix epoch seconds.

- `customer` (object): The created customer resource.

**Example output**

```json
{
  "customer": {
    "auto_collection": "on",
    "card_status": "no_card",
    "company": "Acme Robotics",
    "created_at": 1769385600,
    "email": "jordan.ellis@acme.example",
    "first_name": "Jordan",
    "id": "cust_acme_8f21",
    "last_name": "Ellis",
    "net_term_days": 0,
    "object": "customer",
    "phone": "+1-415-555-0148",
    "preferred_currency_code": "USD",
    "resource_version": 1769385600000,
    "updated_at": 1769385600
  }
}
```

### List Chargebee customers

List customers in your Chargebee site, one page at a time, optionally filtered by an exact email address. Returns a 'list' of customer records plus a 'next_offset' cursor when more pages are available. Useful for finding a customer's ID by email or exporting the customer base.

**Inputs**

- Email (`email`, text): Filter to customers with this exact email address. Leave blank to list all customers.
- Limit (`limit`, number): How many records to return in one page, from 1 to 100. Defaults to 10. From 1 to 100.
- Continue from (`offset`, text): To get the next page, paste the 'next_offset' value returned by the previous call. Leave blank for the first page.

**Outputs**: Paginated list. Each entry in 'list' wraps a customer under a 'customer' key. 'next_offset' is present only when more pages remain; pass it back as 'offset' to continue.

- `list` (list): Array of { customer: {...} } entries.
- `next_offset` (text): Cursor for the next page; absent on the last page.

**Example output**

```json
{
  "list": [
    {
      "customer": {
        "auto_collection": "on",
        "company": "Acme Robotics",
        "created_at": 1769385600,
        "email": "jordan.ellis@acme.example",
        "first_name": "Jordan",
        "id": "cust_acme_8f21",
        "last_name": "Ellis",
        "object": "customer"
      }
    },
    {
      "customer": {
        "auto_collection": "off",
        "company": "Globex",
        "created_at": 1769299200,
        "email": "priya@globex.example",
        "first_name": "Priya",
        "id": "cust_globex_3b90",
        "last_name": "Nair",
        "object": "customer"
      }
    }
  ],
  "next_offset": "[\"1769299200000\",\"cust_globex_3b90\"]"
}
```

### List Chargebee invoices

List invoices in your Chargebee site, one page at a time, optionally filtered by customer ID and/or status. Returns a 'list' of invoice records with a 'next_offset' cursor. Amounts are in the currency's minor units (e.g. cents). Useful for accounts-receivable checks, chasing unpaid invoices, or revenue reporting.

**Inputs**

- Customer ID (`customer_id`, text): Filter to invoices for this customer ID. Leave blank for all customers.
- Status (`status`, text): Filter by invoice status. One of: paid, posted, payment_due, not_paid, voided, pending. Leave blank for all statuses. One of: `paid`, `posted`, `payment_due` (Payment Due), `not_paid` (Not Paid), `voided`, `pending`.
- Limit (`limit`, number): How many records to return in one page, from 1 to 100. Defaults to 10. From 1 to 100.
- Continue from (`offset`, text): To get the next page, paste the 'next_offset' value returned by the previous call. Leave blank for the first page.

**Outputs**: Paginated list. Each entry wraps an 'invoice'. 'total', 'amount_paid', and 'amount_due' are integers in the currency's minor units (e.g. cents). Dates are Unix epoch seconds.

- `list` (list)
- `next_offset` (text): Cursor for the next page; absent on the last page.

**Example output**

```json
{
  "list": [
    {
      "invoice": {
        "amount_due": 0,
        "amount_paid": 9900,
        "currency_code": "USD",
        "customer_id": "cust_acme_8f21",
        "date": 1769385600,
        "due_date": 1769385600,
        "id": "INV-00042",
        "object": "invoice",
        "status": "paid",
        "subscription_id": "sub_acme_pro_01",
        "total": 9900
      }
    },
    {
      "invoice": {
        "amount_due": 24900,
        "amount_paid": 0,
        "currency_code": "USD",
        "customer_id": "cust_globex_3b90",
        "date": 1769385600,
        "due_date": 1771977600,
        "id": "INV-00043",
        "object": "invoice",
        "status": "payment_due",
        "subscription_id": "sub_globex_team_02",
        "total": 24900
      }
    }
  ],
  "next_offset": null
}
```

### List Chargebee subscriptions

List subscriptions in your Chargebee site, one page at a time, optionally filtered by customer ID and/or status. Returns a 'list' of subscription records with a 'next_offset' cursor for paging. Useful for monitoring active subscriptions, spotting cancellations, or auditing a customer's plans.

**Inputs**

- Customer ID (`customer_id`, text): Filter to subscriptions belonging to this customer ID. Leave blank for all customers.
- Status (`status`, text): Filter by subscription status. One of: future, in_trial, active, non_renewing, paused, cancelled. Leave blank for all statuses. One of: `future`, `in_trial` (In Trial), `active`, `non_renewing` (Non Renewing), `paused`, `cancelled`.
- Limit (`limit`, number): How many records to return in one page, from 1 to 100. Defaults to 10. From 1 to 100.
- Continue from (`offset`, text): To get the next page, paste the 'next_offset' value returned by the previous call. Leave blank for the first page.

**Outputs**: Paginated list. Each entry wraps a 'subscription' (and often the related 'customer' and 'card'). Money fields such as 'mrr' are in the currency's minor units (e.g. cents). Term timestamps are Unix epoch seconds.

- `list` (list)
- `next_offset` (text): Cursor for the next page; absent on the last page.

**Example output**

```json
{
  "list": [
    {
      "customer": {
        "email": "jordan.ellis@acme.example",
        "id": "cust_acme_8f21",
        "object": "customer"
      },
      "subscription": {
        "billing_period": 1,
        "billing_period_unit": "month",
        "created_at": 1769385600,
        "currency_code": "USD",
        "current_term_end": 1772064000,
        "current_term_start": 1769385600,
        "customer_id": "cust_acme_8f21",
        "id": "sub_acme_pro_01",
        "mrr": 9900,
        "next_billing_at": 1772064000,
        "object": "subscription",
        "status": "active"
      }
    }
  ],
  "next_offset": null
}
```

### Retrieve a Chargebee customer

Look up a single Chargebee customer by their customer ID and return the full customer record: contact details, billing preferences, account credits, and card status. Useful for confirming a customer exists or reading their current details before creating a subscription or sending a message.

**Inputs**

- Customer ID (`customer_id`, text, required): The Chargebee customer ID (for example the 'id' returned by Create customer or List customers).

**Outputs**: The customer resource wrapped under a 'customer' key (same shape as Create customer).

- `customer` (object)

**Example output**

```json
{
  "customer": {
    "auto_collection": "on",
    "card_status": "valid",
    "company": "Acme Robotics",
    "created_at": 1769385600,
    "email": "jordan.ellis@acme.example",
    "first_name": "Jordan",
    "id": "cust_acme_8f21",
    "last_name": "Ellis",
    "net_term_days": 0,
    "object": "customer",
    "phone": "+1-415-555-0148",
    "preferred_currency_code": "USD",
    "resource_version": 1769472000000,
    "updated_at": 1769472000
  }
}
```