> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Chargebee

> How to set up the Chargebee connector, plus the actions and events that are available.

![Chargebee](https://stackone-logos.com/api/chargebee/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/chargebee/changelog.md)

[60 actions](#actions) · [1 event](#events) · 1 auth method

Billing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/chargebee/guides/connector-profile/api-key.md)
>
> Uses HTTP Basic Auth with an API key as the username and a dummy password. API keys are environment-specific (test vs li...

Optionally, configure receiving Events for Chargebee into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/chargebee/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/chargebee/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

60 actions

ActionDescription

List Customers`chargebee_list_customers`

Retrieve a paginated list of all customers sorted by creation date, with optional filtering by email, first name, last n...

Get Customer`chargebee_get_customer`

Retrieve the full customer object by its unique Chargebee customer ID, including billing address, payment method, contac...

Create Customer`chargebee_create_customer`

Create a new customer record in Chargebee with optional contact details (name, email, phone, company), auto-collection p...

Update Customer`chargebee_update_customer`

Update an existing customer's contact details (first name, last name, email, phone, company), auto-collection setting, n...

Delete Customer`chargebee_delete_customer`

Soft-delete a customer from Chargebee by marking them as deleted (data is retained and retrievable via the list API). Fa...

List Subscriptions`chargebee_list_subscriptions`

Retrieve a paginated list of all subscriptions with optional filtering by customer ID, plan ID, creation/update timestam...

Get Subscription`chargebee_get_subscription`

Retrieve the full subscription object by its unique Chargebee subscription ID, including plan items, addon items, charge...

Create Subscription For Customer`chargebee_create_subscription_for_customer`

Create a new subscription for an existing customer with a required plan item price, optional addon quantities, unit pric...

Update Subscription`chargebee_update_subscription`

Update an existing subscription's plan item price, quantities, auto-collection, purchase order number, or metadata. Supp...

Cancel Subscription`chargebee_cancel_subscription`

Cancel a subscription immediately or schedule cancellation at the end of the current billing term via end\_of\_term flag....

Reactivate Subscription`chargebee_reactivate_subscription`

Reactivate a previously cancelled subscription to restore billing. The subscription must be in cancelled status. It move...

Pause Subscription`chargebee_pause_subscription`

Pause an active subscription to temporarily suspend billing without cancelling it. Can pause immediately or at end of te...

Resume Subscription`chargebee_resume_subscription`

Resume a paused subscription to restore active billing. The subscription must be in paused status. Resumes immediately i...

Remove Scheduled Changes`chargebee_remove_scheduled_changes`

Remove all scheduled changes from a subscription, clearing any pending modifications (plan changes, quantity updates, ad...

List Invoices`chargebee_list_invoices`

Retrieve a paginated list of all invoices with optional filtering by customer ID, subscription ID, recurring flag, date...

Get Invoice`chargebee_get_invoice`

Retrieve the full invoice object by its unique Chargebee invoice ID, including status (paid, posted, payment\_due, not\_pa...

Create Invoice For One-Time Charge`chargebee_create_invoice_for_charge`

Create a non-recurring invoice for a customer with one-time charges (setup fees, consulting, ad-hoc billing) not tied to...

Void Invoice`chargebee_void_invoice`

Void an invoice to change its status to voided, reversing any collected payments and creating adjustment credit notes. N...

Collect Invoice Payment`chargebee_collect_invoice_payment`

Attempt to collect payment for an invoice in payment\_due or not\_paid status using the customer's primary payment method...

Download Invoice PDF`chargebee_download_invoice_pdf`

Generate a temporary download URL for the PDF version of an invoice. The PDF includes all invoice details (line items, t...

Write Off Invoice`chargebee_write_off_invoice`

Write off the outstanding balance on an invoice in payment\_due or not\_paid status, marking it as uncollectible bad debt....

Close Invoice`chargebee_close_invoice`

Close a pending invoice to finalize it and transition it from pending status to a collectible state (payment\_due or paid...

List Credit Notes`chargebee_list_credit_notes`

Retrieve a paginated list of all credit notes (adjustment, refundable, and store credit types) with optional filtering b...

Get Credit Note`chargebee_get_credit_note`

Retrieve the full credit note object by its unique Chargebee credit note ID, including type (adjustment reduces invoice...

Create Credit Note`chargebee_create_credit_note`

Create a new credit note against a reference invoice for a specified total amount in cents. Supports adjustment type (re...

List Items`chargebee_list_items`

Retrieve a paginated list of all product catalog items (plans, addons, charges) with optional filtering by name, item ID...

Get Item`chargebee_get_item`

Retrieve the full item object by its unique Chargebee item ID, including type (plan, addon, charge), status (active, arc...

Create Item`chargebee_create_item`

Create a new item (plan, addon, or charge) in the product catalog with a required ID, name, and type. Requires an item\_f...

Update Item`chargebee_update_item`

Update an existing product catalog item's name, description, external name (customer-facing), checkout enablement, porta...

Delete Item`chargebee_delete_item`

Delete an item from the product catalog by setting its status to deleted. The item must not have any active item prices...

List Item Prices`chargebee_list_item_prices`

Retrieve a paginated list of all item prices (price points for catalog items) with optional filtering by item ID, item p...

Get Item Price`chargebee_get_item_price`

Retrieve the full item price object by its unique Chargebee item price ID, including pricing model (flat\_fee, per\_unit,...

Create Item Price`chargebee_create_item_price`

Create a new item price for a catalog item with a required ID, item\_id, name, pricing model, and currency code. An item...

Update Item Price`chargebee_update_item_price`

Update an existing item price's amount (in minor currency units), name, external name, description, trial period setting...

Delete Item Price`chargebee_delete_item_price`

Delete an item price from the product catalog by setting its status to deleted. The item price must not be associated wi...

List Item Families`chargebee_list_item_families`

Retrieve a paginated list of all item families (product line groupings) in the catalog. Item families compartmentalize i...

Get Item Family`chargebee_get_item_family`

Retrieve the full item family object by its unique Chargebee item family ID, including name (visible only in Chargebee U...

List Coupons`chargebee_list_coupons`

Retrieve a paginated list of all coupons with optional filtering by name or coupon ID. Returns discount type (fixed\_amou...

Get Coupon`chargebee_get_coupon`

Retrieve the full coupon object by its unique Chargebee coupon ID, including discount type (fixed\_amount, percentage, of...

Create Coupon For Items`chargebee_create_coupon_for_items`

Create a new coupon with a required ID, name, discount type (fixed\_amount deducts a set amount in cents, percentage dedu...

Delete Coupon`chargebee_delete_coupon`

Delete a coupon so it can no longer be applied to new subscriptions. The coupon status changes to deleted. Existing coup...

Update Coupon`chargebee_update_coupon`

Update an existing coupon's display name, invoice name, discount amount (for fixed\_amount type, in cents), discount perc...

List Orders`chargebee_list_orders`

Retrieve a paginated list of all orders (fulfillment records for physical products, auto-generated when invoices are pai...

Get Order`chargebee_get_order`

Retrieve the full order object by its unique Chargebee order ID, including fulfillment status (new, processing, complete...

Create Order`chargebee_create_order`

Create a new order linked to an existing invoice by invoice\_id, representing a fulfillment record for physical products....

Update Order`chargebee_update_order`

Update an existing order's status, reference\_id for external system mapping, tracking details (tracking\_id, tracking\_url...

List Payment Sources`chargebee_list_payment_sources`

Retrieve a paginated list of all saved payment sources (cards, direct debits, PayPal, Apple Pay, Google Pay, bank transf...

Get Payment Source`chargebee_get_payment_source`

Retrieve the full payment source object by its unique Chargebee payment source ID, including type (card, direct\_debit, p...

List Transactions`chargebee_list_transactions`

Retrieve a paginated list of all payment transactions (authorizations, payments, refunds, payment reversals) with option...

Get Transaction`chargebee_get_transaction`

Retrieve the full transaction object by its unique Chargebee transaction ID, including type (authorization, payment, ref...

List Events`chargebee_list_events`

Retrieve a paginated list of all events (change log entries for subscriptions, invoices, payments, customers, credit not...

Get Event`chargebee_get_event`

Retrieve the full event object by its unique Chargebee event ID, including event\_type, source (admin\_console, api, sched...

List Business Entities`chargebee_list_business_entities`

Retrieve a paginated list of all business entities (distinct legal or operational units like regional offices, acquired...

Get Business Entity`chargebee_get_business_entity`

Retrieve the full business entity object by its unique Chargebee business entity ID, including name, status (active or i...

List Usages`chargebee_list_usages`

Retrieve a list of usage records for a specific metered subscription item. Requires both subscription\_id and item\_price\_...

Create Usage`chargebee_create_usage`

Record a usage entry for a metered subscription item with a required item\_price\_id, quantity (as string), and usage\_date...

Delete Usage`chargebee_delete_usage`

Delete a specific usage record for a metered subscription item by providing subscription\_id as a path parameter and item...

List Hosted Pages`chargebee_list_hosted_pages`

Retrieve a paginated list of all hosted pages (Chargebee-managed secure checkout, payment update, and subscription manag...

Get Hosted Page`chargebee_get_hosted_page`

Retrieve the full hosted page object by its unique Chargebee hosted page ID, including type, URL, state (created, reques...

Create Checkout For New Subscription`chargebee_create_checkout_new_subscription`

Generate a secure hosted checkout page URL (expires in 3 hours) for creating a new subscription with a required plan ite...

## Events

Tags

Select all
|
Clear

Webhooks

No tags found

1 event

EventDescriptionTags

Event`chargebee_webhook_event`

Fires for every Chargebee webhook. Chargebee delivers a single generic event envelope for all of its \~209 event types (s...

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.