Chargebee

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

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

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

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

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

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

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

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

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

Cancel a subscription immediately or schedule cancellation at the end of the current billing term via end_of_term flag…

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

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

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

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

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

Retrieve the full invoice object by its unique Chargebee invoice ID, including status (paid, posted, payment_due, not_pa…

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

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

Attempt to collect payment for an invoice in payment_due or not_paid status using the customer’s primary payment method…

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

Write off the outstanding balance on an invoice in payment_due or not_paid status, marking it as uncollectible bad debt…

Close a pending invoice to finalize it and transition it from pending status to a collectible state (payment_due or paid…

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

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

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

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

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

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

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

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

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

Retrieve the full item price object by its unique Chargebee item price ID, including pricing model (flat_fee, per_unit,…

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

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

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

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

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

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

Retrieve the full coupon object by its unique Chargebee coupon ID, including discount type (fixed_amount, percentage, of…

Create a new coupon with a required ID, name, discount type (fixed_amount deducts a set amount in cents, percentage dedu…

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

Update an existing coupon’s display name, invoice name, discount amount (for fixed_amount type, in cents), discount perc…

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

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

Create a new order linked to an existing invoice by invoice_id, representing a fulfillment record for physical products…

Update an existing order’s status, reference_id for external system mapping, tracking details (tracking_id, tracking_url…

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

Retrieve the full payment source object by its unique Chargebee payment source ID, including type (card, direct_debit, p…

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

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

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

Retrieve the full event object by its unique Chargebee event ID, including event_type, source (admin_console, api, sched…

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

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

Retrieve a list of usage records for a specific metered subscription item. Requires both subscription_id and item_price_…

Record a usage entry for a metered subscription item with a required item_price_id, quantity (as string), and usage_date…

Delete a specific usage record for a metered subscription item by providing subscription_id as a path parameter and item…

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

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

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