Chargebee integration

Overview

Chargebee is a subscription billing and revenue management platform. This tool provides access to the Chargebee API v2 for creating customers, listing invoices with date/amount filters, retrieving invoice PDF download URLs, and cancelling or deleting subscriptions. Uses HTTP Basic Auth with the Chargebee API key. All POST parameters are form-urlencoded per Chargebee API conventions.

Node Type

Action — processes input items and produces output

Input / Output

Direction	Port(s)
Input	Input
Output	Output, Error

Credentials

This tool requires Chargebee API credentials. See the Credentials Guide for setup instructions.

Resources

Resource	Value
Customer	customer
Invoice	invoice
Subscription	subscription

Operations

Each resource has its own Operation list. Pick the resource first, then the operation.

Resource	Operation	Value	Description
Customer	Create	create	Create a new customer
Invoice	List	list	List invoices with optional filters
Invoice	PDF Invoice URL	pdfUrl	Get the PDF download URL for a specific invoice
Subscription	Cancel	cancel	Cancel a subscription
Subscription	Delete	delete	Delete a subscription permanently

Parameters

Customer: Create

Parameter	Type	Required	Default	Description
Properties	collection	No	{}	Properties to set on the new customer.
— User ID	string	No	—	ID for the new customer. If not given, this will be auto-generated.
— First Name	string	No	—	The first name of the customer.
— Last Name	string	No	—	The last name of the customer.
— Email	string	No	—	The email address of the customer.
— Phone	string	No	—	The phone number of the customer.
— Company	string	No	—	The company of the customer.
— Custom Properties	fixedCollection	No	{}	Adds custom properties as key-value pairs. Each pair is sent as a separate form-encoded parameter.
— — Property Name	string	No	—	Name of the property to set.
— — Property Value	string	No	—	Value of the property to set.

Invoice: List

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	10	Max number of results to return. (shown when Return All is false)
Filters	fixedCollection	No	{}	Filter invoices by date or amount.
				Options: is
— Operation	options	No	after	The comparison operation for the date filter.
				Options: is, is_not, after, before
— Date	string	No	—	Query date in ISO 8601 format (e.g. 2024-01-15T00:00:00Z). Converted to Unix timestamp internally.
— Operation	options	No	gt	The comparison operation for the amount filter.
				Options: is, is_not, gt, gte, lt, lte
— Amount	number	No	0	Query amount (in cents for most currencies).

Invoice: PDF Invoice URL

Parameter	Type	Required	Default	Description
Invoice ID	string	Yes	—	The ID of the invoice to get the PDF URL for.

Subscription: Cancel

Parameter	Type	Required	Default	Description
Subscription ID	string	Yes	—	The ID of the subscription to cancel.
Schedule End of Term	boolean	No	false	Whether to schedule the cancellation for the end of the current billing term instead of cancelling immediately.

Subscription: Delete

Parameter	Type	Required	Default	Description
Subscription ID	string	Yes	—	The ID of the subscription to delete permanently.

All Operations

Parameter	Type	Required	Default	Description
Max Concurrency	number	No	10	Maximum number of items to process concurrently.

Output Data

What lands on the output item depends on the operation, but in every case binary data on the input item is forwarded unchanged.

Operation	Output
Customer Create, Subscription Cancel, Subscription Delete	One output item per input item. The Chargebee response is merged onto the input item’s JSON at the top level, so the fields the item already carried are still there and a response key with the same name overwrites the item’s value.
Invoice PDF Invoice URL	One output item per input item. Only pdfUrl is added — the rest of the input item JSON passes through untouched. pdfUrl is null when the response carries no download URL.
Invoice List	Fans out: one output item per invoice returned. Each invoice object replaces the item JSON entirely — nothing from the input item survives, so carry forward any value you still need before this node. A request that matches no invoices produces no output items at all for that input item, which quietly ends that branch.

List results are unwrapped, so invoice fields sit at the top level of the output item ({{ $json.id }}, {{ $json.total }}). Invoices are returned newest first by invoice date. With Return All on, the node pages through results for you.

Example Configuration

Create a customer from an upstream signup record, including custom properties:

{
  "type": "chargebee",
  "parameters": {
    "resource": "customer",
    "operation": "create",
    "properties": {
      "id": "customer_001",
      "first_name": "{{ $json.firstName }}",
      "last_name": "{{ $json.lastName }}",
      "email": "{{ $json.email }}",
      "phone": "+1-555-0123",
      "company": "Acme Corp",
      "customProperties": {
        "property": [
          { "name": "department", "value": "engineering" },
          { "name": "tier", "value": "premium" }
        ]
      }
    }
  }
}

List every invoice raised after a date and above an amount:

{
  "type": "chargebee",
  "parameters": {
    "resource": "invoice",
    "operation": "list",
    "returnAll": true,
    "filters": {
      "date": [
        { "operation": "after", "value": "2026-01-01T00:00:00Z" }
      ],
      "total": [
        { "operation": "gt", "value": 100 }
      ]
    }
  }
}

List a single page of invoices:

{
  "type": "chargebee",
  "parameters": {
    "resource": "invoice",
    "operation": "list",
    "returnAll": false,
    "limit": 50
  }
}

Get the PDF download URL for the invoice an upstream node produced:

{
  "type": "chargebee",
  "parameters": {
    "resource": "invoice",
    "operation": "pdfUrl",
    "invoiceId": "{{ $json.id }}"
  }
}

Cancel a subscription at the end of the current billing term:

{
  "type": "chargebee",
  "parameters": {
    "resource": "subscription",
    "operation": "cancel",
    "subscriptionId": "{{ $json.subscription_id }}",
    "endOfTerm": true
  }
}

Delete a subscription permanently:

{
  "type": "chargebee",
  "parameters": {
    "resource": "subscription",
    "operation": "delete",
    "subscriptionId": "sub_xyz789"
  }
}

Error Handling

Mode	Behavior
stop	Halts workflow on first error
continue	Skips failed items, passes successful ones through
errorPort	Routes failed items to Error output port

Tips

This tool uses Chargebee to manage customers, invoices, and subscriptions. It is the right tool for handling subscription billing and revenue management tasks rather than general accounting or payment gateways. It produces new customer records, lists of invoices, invoice PDF download links, and cancelled or deleted subscriptions.

• Repeated runs are safe. Create, Cancel and Delete calls are sent with an idempotency key that is stable for the same item within the same execution, so a retry inside that execution does not create a second customer or cancel twice. A fresh execution is a fresh operation.
• Amounts are in the currency’s smallest unit. The invoice amount filter compares cents for most currencies.
• Max Concurrency controls the API call rate. The default of 10 suits most runs; lower it when a large batch of items starts drawing rate-limit errors.