Chargebee
Keep Chargebee in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
62 ways to read, 22 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Chargebee, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Attach item to a plan itemApproval by rule
- Create couponApproval by rule
- List attached items of an itemRead
Example flow
- Chargebee · List attached items of an itemDone
- Chargebee · Attach item to a plan itemNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Chargebee.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Chargebee
- Chargebee's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Chargebee test account before you go live.
For developers
Technical detail
Chargebee customers, subscriptions, item catalogue (items, prices, attachments, differential prices, variants, products), coupons and usage; invoices, credit notes, orders, entitlements and events.
Chargebee API docs- Source actions
- 62
- Destination actions
- 22
- Data types
- 36
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Attached items4
- Attach item to a plan itemDestinationProvider duplicate protectionApproval before production
Attaches an add-on or charge item to a plan item (recommended, mandatory or optional).
- Get attached itemSource
One attached item by ID.
- List attached items of an itemSourceIncremental
Attached items of an item with offset pagination and incremental updated_at[after].
- Update attached itemDestinationProvider duplicate protectionApproval before production
Updates an attachment's type, quantity, billing cycles and charge event.
Comments2
- Get commentSource
One comment by ID.
- List commentsSource
Comments with offset pagination.
Contract terms1
- List contract terms of a subscriptionSource
Contract terms of a subscription with offset pagination.
Coupon codes2
- Get coupon codeSource
One coupon code by ID.
- List coupon codesSource
Coupon codes with offset pagination.
Coupon sets2
- Get coupon setSource
One coupon set by ID.
- List coupon setsSource
Coupon sets with offset pagination.
Coupons4
- Create couponDestinationProvider duplicate protectionApproval before production
Creates a coupon for items (create_a_coupon_for_items).
- Get couponSource
One coupon by ID.
- List couponsSourceIncremental
Coupons with offset pagination and incremental updated_at[after].
- Update couponDestinationProvider duplicate protectionApproval before production
Updates a coupon for items (update_a_coupon_for_items).
Credit notes2
- Get credit noteSource
One credit note by ID.
- List credit notesSourceIncremental
Credit notes with offset pagination and incremental updated_at[after].
Currencies2
- Get site currencySource
One site currency by ID.
- List site currenciesSource
Site currencies with offset pagination.
Custom field configs1
- List custom field configurationsSource
Custom field configurations with offset pagination.
Customer contacts1
- List contacts of a customerSource
Contacts of a customer with offset pagination.
Customer entitlements1
- List entitlements of a customerSource
Entitlements of a customer with offset pagination.
Customers4
- Create customerDestinationProvider duplicate protectionApproval before production
Creates a customer with billing address, custom fields and metadata.
- Get customerSource
One customer by ID.
- List customersSourceIncremental
Customers with offset pagination and incremental updated_at[after].
- Update customerDestinationProvider duplicate protectionApproval before production
Updates supplied customer fields. Billing address changes use Chargebee's billing info endpoint and are not included.
Differential prices4
- Create differential priceDestinationProvider duplicate protectionApproval before production
Sets a different add-on or charge price for a specific plan item.
- Get differential priceSource
One differential price by ID and its item price.
- List differential pricesSource
Differential prices with offset pagination.
- Update differential priceDestinationProvider duplicate protectionApproval before production
Updates a differential price's amount, tiers or parent periods.
Disputes2
- Get disputeSource
One dispute by ID.
- List disputes (read only)SourceIncremental
Disputes (read only) with offset pagination.
Entitlements1
- List entitlements of plans, add-ons and chargesSource
Entitlements of plans, add-ons and charges with offset pagination.
Events2
- Get eventSource
One event by ID.
- List eventsSourceIncremental
Events with offset pagination.
Features2
- Get featureSource
One feature by ID.
- List featuresSource
Features with offset pagination.
Invoice payments1
- List payments applied to an invoice (read only)Source
Payments applied to an invoice (read only) with offset pagination.
Invoices3
- Create pending invoiceDestinationProvider duplicate protectionApproval before production
Creates a pending invoice for a subscription from item prices and one-time charges. No payment is collected.
- Get invoiceSource
One invoice by ID.
- List invoicesSourceIncremental
Invoices with offset pagination and incremental updated_at[after].
Item families4
- Create item familyDestinationProvider duplicate protectionApproval before production
Creates an item family that groups plans, addons and charges.
- Get item familySource
One item family by ID.
- List item familiesSourceIncremental
Item families with offset pagination and incremental updated_at[after].
- Update item familyDestinationProvider duplicate protectionApproval before production
Updates an item family name or description.
Item prices4
- Create item priceDestinationProvider duplicate protectionApproval before production
Creates a price point for an item with pricing model, period and optional tiers.
- Get item priceSource
One item price by ID.
- List item pricesSourceIncremental
Item prices with offset pagination and incremental updated_at[after].
- Update item priceDestinationProvider duplicate protectionApproval before production
Updates supplied item price fields. Archiving is not automated.
Items4
- Create itemDestinationProvider duplicate protectionApproval before production
Creates a plan, addon or charge item in an item family.
- Get itemSource
One item by ID.
- List items (plans, addons and charges)SourceIncremental
Items (plans, addons and charges) with offset pagination and incremental updated_at[after].
- Update itemDestinationProvider duplicate protectionApproval before production
Updates supplied item fields. Archiving is not automated.
Orders2
- Get orderSource
One order by ID.
- List orders (read only)SourceIncremental
Orders (read only) with offset pagination and incremental updated_at[after].
Price variants4
- Create price variantDestinationProvider duplicate protectionApproval before production
Creates a price variant (for example a regional price list) used by item prices.
- Get price variantSource
One price variant by ID.
- List price variantsSourceIncremental
Price variants with offset pagination and incremental updated_at[after].
- Update price variantDestinationProvider duplicate protectionApproval before production
Updates a price variant's names, description, group and attributes. Archiving is not automated.
Product variants2
- Get product variantSource
One product variant by ID.
- List variants of a productSourceIncremental
Variants of a product with offset pagination and incremental updated_at[after].
Products4
- Create productDestinationProvider duplicate protectionApproval before production
Creates a Chargebee product (product catalogue products and variants).
- Get productSource
One product by ID.
- List productsSourceIncremental
Products with offset pagination and incremental updated_at[after].
- Update productDestinationProvider duplicate protectionApproval before production
Updates supplied product fields.
Promotional credits2
- Get promotional credit entrySource
One promotional credit entry by ID.
- List promotional credit history (read only)Source
Promotional credit history (read only) with offset pagination.
Quotes2
- Get quoteSource
One quote by ID.
- List quotesSourceIncremental
Quotes with offset pagination and incremental updated_at[after].
Ramps2
- Get subscription rampSource
One subscription ramp by ID.
- List subscription ramps (read only)SourceIncremental
Subscription ramps (read only) with offset pagination and incremental updated_at[after].
Subscription discounts1
- List discounts of a subscriptionSource
Discounts of a subscription with offset pagination.
Subscription entitlements1
- List entitlements of a subscriptionSource
Entitlements of a subscription with offset pagination.
Subscriptions4
- Create subscriptionDestinationProvider duplicate protectionApproval before production
Creates a subscription for an existing customer from item prices (create_subscription_for_items). Immediate charges are added to unbilled charges.
- Get subscriptionSource
One subscription by ID.
- List subscriptionsSourceIncremental
Subscriptions with offset pagination and incremental updated_at[after].
- Update subscriptionDestinationProvider duplicate protectionApproval before production
Updates subscription items, coupons and terms (update_subscription_for_items). Supplied items are merged unless replaceItemsList is true.
Transactions2
- Get transactionSource
One transaction by ID.
- List transactions (payments and refunds, read only)SourceIncremental
Transactions (payments and refunds, read only) with offset pagination and incremental updated_at[after].
Unbilled charges1
- List unbilled chargesSource
Unbilled charges with offset pagination.
Usages2
- Record usageDestinationNot retried automaticallyApproval before production
Records usage for a metered item price on a subscription.
- List usage recordsSourceIncremental
Usage records with offset pagination and incremental updated_at[after].
Webhook endpoints2
- Get webhook endpointSource
One webhook endpoint by ID.
- List webhook endpoints (read only)Source
Webhook endpoints (read only) with offset pagination.
Access and limits
- Authentication
- Chargebee API key (HTTP Basic username)
- Plans and access
- All Chargebee plans include API access with full-access or read-only API keys. API keys are per site. Product Catalog 2.0 (items and item prices) is required; Product Catalog 1.0 plans and addons are not covered.
- Test environment
- Every Chargebee account has a test site ({site}-test.chargebee.com).
- Rate limits
- Per-site request limits depend on the Chargebee plan and are lower on test sites; Chargebee returns HTTP 429 when exceeded and Nexra backs off.
- Pagination
- limit (max 100) and offset, continued with next_offset from the response.
- Provider events
- Chargebee webhooks deliver event objects (for example subscription_created). Flows can start the moment something happens: when a payment succeeds; when a payment fails; when a refund is processed; when a new subscription starts.
Before you build a flow
- Subscription create and update always send invoice_immediately=false, so charges raised by the call go to unbilled charges and are invoiced on the next billing cycle instead of being charged during the flow.
- Invoice create always sets create_pending_invoice=true: Chargebee creates a pending invoice that collects no payment and requires usage-based billing to be enabled on the site and a subscription ID.
- Usage records are recorded against metered item prices and are billed by Chargebee on the next invoice.
- Cancellations, pauses, deletes, voids, write-offs, refunds, payment collection, recorded payments, payment sources and hosted pages are intentionally not automated.
- Archiving items, item prices or coupons (status changes) is not automated.
- Credit notes, transactions, quotes, unbilled charges and events are read only.
- Item constraints on coupons support constraint and item type; specific item price lists must be edited in Chargebee.
- Product Catalog 1.0 (plans and addons) endpoints are not covered.
- Record usage is billable-adjacent: it is marked billable and never retried automatically.
- Attached items, differential prices, price variants and products can be created and updated; features, entitlements, coupon sets and codes, ramps, comments, webhook endpoints, currencies and custom field configurations are read only.
- Orders, disputes, promotional credits and invoice payments are read only. Promotional credit add, deduct and set, coupon code archive, unique code generation, quotes, exports, webhook endpoint changes and comment creation are not offered.
- Differential price parent periods (nested period lists) are not offered; set them in Chargebee.
- Differential price, coupon set, coupon code, feature, entitlement, comment, webhook endpoint and currency lists document no updated_at filter, so they are full reads. Disputes can be filtered by creation time only (created_at), so status changes on older disputes are not picked up by a since-last-run read.
- Payouts and settlements: Chargebee is a billing platform and does not pay out funds, so it has no payout or settlement list. Payouts, settlement lines and processor fees come from the payment gateway (for example Stripe, Adyen or Braintree), which is connected separately.
- Processor fees: Chargebee transactions carry no gateway fee amounts; read fees from the payment gateway connected separately.
- Refunds are read with the transactions list filtered to type refund; disputes are the gateway disputes Chargebee records.
Developer reference
- Create the Chargebee credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Chargebee, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/chargebee and the Connections API.