Skip to main content

Chargebee

Use the Chargebee node to manage customers, invoices, and subscriptions in Chargebee.


Operations

The Chargebee node supports operations on three main resources: Customer, Invoice, and Subscription.

Customer Operations

Create Customer

Create a new customer in Chargebee with the following properties:

  • User ID: Custom ID for the customer, if not given, this will be auto-generated
  • First Name: Customer's first name
  • Last Name: Customer's last name
  • Email: Customer's email address
  • Phone: Customer's phone number
  • Company: Customer's company name
  • Custom Properties: (Additional custom name-value fields):
    • Property Name
    • Property Value

List Customers

Retrieve a list of customers with optional filtering:

  • Max Results: Number of results to return (1-100, default: 10)
  • Filters:
    • Field (First Name, Last Name, or Email)
    • Operation (Is, Is Not, Starts With, In, Not In, Is Present)
    • Value(s) based on the chosen operation

Invoice Operations

List Invoices

Retrieve a list of invoices with filtering options:

  • Max Results: Number of results to return (1-100, default: 10)
  • Filters:
    • Invoice Date:
      • Operation: Is, Is Not, After, Before
      • Date: The reference date for filtering
    • Invoice Amount:
      • Operation: Greater Than, Less Than, Equal To, etc.
      • Amount: The reference amount for filtering

Get PDF Invoice URL

Retrieve the PDF URL for a specific invoice:

  • Invoice ID (required): The ID of the invoice to get the PDF URL for

Subscription Operations

Cancel Subscription

Cancel an existing subscription:

  • Subscription ID (required): The ID of the subscription to cancel
  • Schedule End of Term: Whether to cancel immediately or at the end of the billing period

Delete Subscription

Delete a subscription:

  • Subscription ID (required): The ID of the subscription to delete