The Chargebee connector lets your AI agent act in each user's Chargebee account. Each user connects their own Chargebee API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 27 tools.
- Tools
- 27
- What they doRead · write · destructive
- 15 · 10 · 215 read10 write2 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Chargebee connection
In AgentKit > Connections, create a Chargebee connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolchargebee_coupon_getGet one Chargebee coupon by ID.Read-onlyGet Coupon
Get one Chargebee coupon by ID. Returns the coupon with discount, duration, validity dates, redemption limits and the item constraints it applies to. Use chargebee_coupon_get when you have the coupon ID. Use chargebee_coupons_list to browse coupons.
Inputs
coupon_idstringrequired- ID of the coupon, from chargebee_coupons_list. Example: SUMMER20.
chargebee_coupons_listList coupons in Chargebee, optionally filtered by status, discount type, duration type, name or creation time.Read-onlyList Coupons
List coupons in Chargebee, optionally filtered by status, discount type, duration type, name or creation time. Returns a list of coupon objects (id, name, discount_type, discount_percentage or discount_amount, duration_type, status, redemptions) and next_offset when more pages exist. Use chargebee_coupons_list to find a coupon to apply. Use chargebee_coupon_get when you already have the coupon ID.
Inputs
created_afterinteger- Only coupons created after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
discount_typestring- Only coupons with this discount type. Example: percentage.one of
fixed_amountpercentageoffer_quantity duration_typestring- Only coupons with this duration type. Example: forever.one of
one_timeforeverlimited_period limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
name_starts_withstring- Only coupons whose name starts with this text. Example: Summer.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
sort_by_descstring- Sort the results in descending order by this attribute. Example: created_at.one of
created_at statusstring- Only coupons in this status. Example: active.one of
activeexpiredarchiveddeletedfuture
chargebee_credit_note_getGet one Chargebee credit note by ID.Read-onlyGet Credit Note
Get one Chargebee credit note by ID. Returns the credit note with line items, taxes, allocations to invoices and refunds. Use chargebee_credit_note_get when you have the credit note ID. Use chargebee_credit_notes_list to search.
Inputs
credit_note_idstringrequired- ID of the credit note, from chargebee_credit_notes_list. Example: CN-112.
chargebee_credit_notes_listList credit notes in Chargebee, optionally filtered by customer, subscription, reference invoice, status, type or date.Read-onlyList Credit Notes
List credit notes in Chargebee, optionally filtered by customer, subscription, reference invoice, status, type or date. Returns a list of credit note objects (id, type, status, reference_invoice_id, total, amount_allocated, amount_refunded, amount_available) and next_offset when more pages exist. Use chargebee_credit_notes_list to find credits or refunds. Use chargebee_credit_note_get when you already have the credit note ID.
Inputs
customer_idstring- Only credit notes of this customer ID. Example: 16BjfNSzYXqA21Dt.
date_afterinteger- Only credit notes dated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
date_beforeinteger- Only credit notes dated before this time. Unix timestamp in seconds (UTC). Example: 1735689600.
include_deletedboolean- Set to true to also return deleted credit notes. Defaults to false.
limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
reference_invoice_idstring- Only credit notes issued against this invoice ID. Example: 1024.
sort_by_ascstring- Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: date.one of
date sort_by_descstring- Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: date.one of
date statusstring- Only credit notes in this status. Example: refund_due.one of
adjustedrefundedrefund_duevoided subscription_idstring- Only credit notes of this subscription ID. Example: AzZTZgTSz7nCt3Pu.
typestring- Only credit notes of this type. Example: refundable.one of
adjustmentrefundablestore
chargebee_customer_getGet one Chargebee customer by ID.Read-onlyGet Customer
Get one Chargebee customer by ID. Returns the customer object (contact details, billing address, payment method summary, balances, meta_data) and its primary card if any. Use chargebee_customer_get when you have the customer ID. Use chargebee_customers_list to search by email or name.
Inputs
customer_idstringrequired- ID of the customer, from chargebee_customers_list or the Chargebee app. Example: 16BjfNSzYXqA21Dt.
chargebee_customers_listList customers in Chargebee, optionally filtered by email, name, company or created/updated time.Read-onlyList Customers
List customers in Chargebee, optionally filtered by email, name, company or created/updated time. Returns a list of customer objects (id, name, email, company, billing address, auto_collection, balances) and next_offset when more pages exist. Use chargebee_customers_list to find a customer or browse. Use chargebee_customer_get when you already have the customer ID.
Inputs
companystring- Only customers with exactly this company name. Example: Acme Inc.
created_afterinteger- Only customers created after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
created_beforeinteger- Only customers created before this time. Unix timestamp in seconds (UTC). Example: 1735689600.
emailstring- Only customers with exactly this email address. Example: jane@acme.com.
first_namestring- Only customers with exactly this first name. Example: Jane.
include_deletedboolean- Set to true to also return deleted customers. Defaults to false.
last_namestring- Only customers with exactly this last name. Example: Doe.
limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
sort_by_ascstring- Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: created_at.one of
created_atupdated_at sort_by_descstring- Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: created_at.one of
created_atupdated_at updated_afterinteger- Only customers updated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_invoice_getGet one Chargebee invoice by ID.Read-onlyGet Invoice
Get one Chargebee invoice by ID. Returns the invoice with line items, discounts, taxes, applied payments and credits, and amounts paid and due. Use chargebee_invoice_get when you have the invoice ID. Use chargebee_invoices_list to search, and chargebee_invoice_pdf_get for a PDF link.
Inputs
invoice_idstringrequired- ID (number) of the invoice, from chargebee_invoices_list. Example: 1024.
chargebee_invoice_pdf_getGet a temporary download link for an invoice's PDF.Read-onlyGet Invoice PDF Link
Get a temporary download link for an invoice's PDF. Returns a download object with download_url and valid_till (the link expires after about an hour). Use chargebee_invoice_pdf_get to share or save an invoice document. Use chargebee_invoice_get for the invoice data.
Inputs
invoice_idstringrequired- ID (number) of the invoice, from chargebee_invoices_list. Example: 1024.
disposition_typestring- attachment (default) makes the link download the file; inline opens it in the browser. Example: inline.one of
attachmentinline
chargebee_invoices_listList invoices in Chargebee, optionally filtered by customer, subscription, status, date or amount due.Read-onlyList Invoices
List invoices in Chargebee, optionally filtered by customer, subscription, status, date or amount due. Returns a list of invoice objects (id, status, date, total, amount_paid, amount_due, line_items) and next_offset when more pages exist. Use chargebee_invoices_list to find unpaid or recent invoices. Use chargebee_invoice_get when you already have the invoice ID.
Inputs
amount_due_greater_thaninteger- Only invoices with amount_due greater than this amount, in the currency's smallest unit (e.g. cents). Example: 0.
customer_idstring- Only invoices of this customer ID. Example: 16BjfNSzYXqA21Dt.
date_afterinteger- Only invoices dated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
date_beforeinteger- Only invoices dated before this time. Unix timestamp in seconds (UTC). Example: 1735689600.
include_deletedboolean- Set to true to also return deleted invoices. Defaults to false.
limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
sort_by_ascstring- Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: date.one of
dateupdated_at sort_by_descstring- Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: date.one of
dateupdated_at statusstring- Only invoices in this status. Example: payment_due.one of
paidpostedpayment_duenot_paidvoidedpending status_instring- Only invoices in any of these statuses (paid, posted, payment_due, not_paid, voided, pending). A JSON array written as text, e.g. ["payment_due","not_paid"].
subscription_idstring- Only invoices of this subscription ID. Example: AzZTZgTSz7nCt3Pu.
updated_afterinteger- Only invoices updated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_item_getGet one Chargebee catalog item (plan, addon or charge) by ID.Read-onlyGet Item
Get one Chargebee catalog item (plan, addon or charge) by ID. Returns the item with name, type, status, item family, unit and checkout/portal settings. Use chargebee_item_get when you have the item ID. Use chargebee_items_list to browse, and chargebee_item_prices_list for its prices.
Inputs
item_idstringrequired- ID of the item (plan, addon or charge), from chargebee_items_list. Example: pro-plan.
chargebee_item_price_getGet one Chargebee item price by ID.Read-onlyGet Item Price
Get one Chargebee item price by ID. Returns the item price with pricing model, price or tiers, currency, billing period, trial settings and status. Use chargebee_item_price_get when you have the item price ID. Use chargebee_item_prices_list to find prices for an item.
Inputs
item_price_idstringrequired- ID of the item price, from chargebee_item_prices_list. Example: pro-USD-Monthly.
chargebee_item_prices_listList item prices in the Chargebee catalog, optionally filtered by item, item type, status, currency, billing period or pricing model.Read-onlyList Item Prices
List item prices in the Chargebee catalog, optionally filtered by item, item type, status, currency, billing period or pricing model. Returns a list of item price objects (id, item_id, name, pricing_model, price, currency_code, period, period_unit, status) and next_offset when more pages exist. Use chargebee_item_prices_list to find the item price IDs needed for chargebee_subscription_create. Use chargebee_item_price_get for one price's tiers and details.
Inputs
currency_codestring- Only item prices in this ISO 4217 currency. Example: USD.
item_family_idstring- Only prices of items in this item family ID. Example: cloud-storage.
item_idstring- Only prices of this item ID. Example: pro-plan.
item_typestring- Only prices of items of this type: plan, addon or charge. Example: plan.one of
planaddoncharge limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
period_unitstring- Only item prices billed on this period unit. Example: month.one of
dayweekmonthyear pricing_modelstring- Only item prices with this pricing model. Example: per_unit.one of
flat_feeper_unittieredvolumestairstep sort_by_ascstring- Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: name.one of
nameidupdated_at sort_by_descstring- Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: name.one of
nameidupdated_at statusstring- Only item prices in this status. Example: active.one of
activearchiveddeleted
chargebee_items_listList items in the Chargebee product catalog: plans, addons and charges, optionally filtered by type, status, name or item family.Read-onlyList Items
List items in the Chargebee product catalog: plans, addons and charges, optionally filtered by type, status, name or item family. Returns a list of item objects (id, name, type, status, item_family_id) and next_offset when more pages exist. Use chargebee_items_list to browse plans and addons. Use chargebee_item_prices_list for their prices, which subscriptions use.
Inputs
item_family_idstring- Only items in this item family (product line) ID. Example: cloud-storage.
limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
name_starts_withstring- Only items whose name starts with this text. Example: Pro.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
sort_by_ascstring- Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: name.one of
nameidupdated_at sort_by_descstring- Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: name.one of
nameidupdated_at statusstring- Only items in this status. Example: active.one of
activearchiveddeleted typestring- Only items of this type: plan, addon or charge. Example: plan.one of
planaddoncharge updated_afterinteger- Only items updated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_subscription_getGet one Chargebee subscription by ID.Read-onlyGet Subscription
Get one Chargebee subscription by ID. Returns the subscription (status, subscription_items, coupons, current term, next_billing_at, mrr), its customer and primary card. Use chargebee_subscription_get when you have the subscription ID. Use chargebee_subscriptions_list to find subscriptions by customer or status.
Inputs
subscription_idstringrequired- ID of the subscription, from chargebee_subscriptions_list. Example: AzZTZgTSz7nCt3Pu.
chargebee_subscriptions_listList subscriptions in Chargebee, optionally filtered by customer, status, item, item price or dates.Read-onlyList Subscriptions
List subscriptions in Chargebee, optionally filtered by customer, status, item, item price or dates. Returns a list of entries, each with the subscription (id, status, subscription_items, billing period, next_billing_at, mrr) and its customer, plus next_offset when more pages exist. Use chargebee_subscriptions_list to browse or filter. Use chargebee_subscription_get when you already have the subscription ID.
Inputs
created_afterinteger- Only subscriptions created after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
created_beforeinteger- Only subscriptions created before this time. Unix timestamp in seconds (UTC). Example: 1735689600.
customer_idstring- Only subscriptions of this customer ID. Example: 16BjfNSzYXqA21Dt.
include_deletedboolean- Set to true to also return deleted subscriptions. Defaults to false.
item_idstring- Only subscriptions that contain this item (plan, addon or charge) ID. Example: pro-plan.
item_price_idstring- Only subscriptions that contain this item price ID. Example: pro-USD-Monthly.
limitinteger- Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
next_billing_beforeinteger- Only subscriptions whose next billing date is before this time; useful to find upcoming renewals. Unix timestamp in seconds (UTC). Example: 1735689600.
offsetstring- Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
sort_by_ascstring- Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: created_at.one of
created_atupdated_at sort_by_descstring- Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: created_at.one of
created_atupdated_at statusstring- Only subscriptions in this status. Example: active.one of
futurein_trialactivenon_renewingpausedcancelledtransferred status_instring- Only subscriptions in any of these statuses (future, in_trial, active, non_renewing, paused, cancelled, transferred). A JSON array written as text, e.g. ["active","in_trial"].
updated_afterinteger- Only subscriptions updated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_coupon_createCreate a percentage, fixed-amount or free-quantity coupon in Chargebee that applies to the invoice total or to specific items.WriteCreate Coupon
Create a percentage, fixed-amount or free-quantity coupon in Chargebee that applies to the invoice total or to specific items. Returns the new coupon object. Use chargebee_coupon_create to set up a new discount. Apply it with coupon_ids on chargebee_subscription_create or chargebee_subscription_update.
Inputs
apply_onstringrequired- What the discount applies to: invoice_amount (the invoice subtotal) or each_specified_item (each matching line item; set item_constraints). Example: invoice_amount.one of
invoice_amounteach_specified_item idstringrequired- Unique ID for the coupon, up to 100 characters; customers can also enter it as a code. Example: SUMMER20.
namestringrequired- Display name of the coupon, up to 50 characters, unique on the site. Example: Summer 20% off.
currency_codestring- ISO 4217 currency of discount_amount, for fixed_amount coupons on multi-currency sites. Example: USD.
discount_amountinteger- Amount to deduct, in the currency's smallest unit (e.g. 1000 is $10.00), when discount_type is fixed_amount. Example: 1000.
discount_percentagenumber- Percentage to deduct, from 0.01 to 100, when discount_type is percentage. Example: 20.
discount_typestring- Type of discount: percentage (default, set discount_percentage), fixed_amount (set discount_amount and currency_code) or offer_quantity. Example: percentage.one of
fixed_amountpercentageoffer_quantity duration_typestring- How long the discount lasts on a subscription: one_time, forever (default) or limited_period (set period and period_unit). Example: limited_period.one of
one_timeforeverlimited_period invoice_namestring- Name shown on invoices instead of name. Example: Summer discount.
item_constraintsobject- Which items the coupon applies to, written as parallel lists (index 0 of each list is the first rule). constraint is all, none, specific or criteria; item_type is plan, addon or charge; item_price_ids (for specific) is a JSON array written as text. Needed when apply_on is each_specified_item. Example: {"constraint": ["all"], "item_type": ["plan"]}.
max_redemptionsinteger- Maximum number of times the coupon can be redeemed. Leave empty for no limit. Example: 100.
periodinteger- Number of period_units the discount lasts, when duration_type is limited_period. Example: 3.
period_unitstring- Unit of period, when duration_type is limited_period. Example: month.one of
dayweekmonthyear valid_tillinteger- Last time the coupon can be applied to new subscriptions. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_credit_note_createCreate a credit note in Chargebee for a total amount, against an invoice or as customer credit.WriteCreate Credit Note
Create a credit note in Chargebee for a total amount, against an invoice or as customer credit. Returns the new credit note. Use chargebee_credit_note_create to give a partial credit or refundable credit. Use chargebee_invoice_void to cancel a whole unpaid invoice instead.
Inputs
typestringrequired- Type of credit note: adjustment (reduces the amount due on an unpaid invoice; needs reference_invoice_id), refundable (for a paid invoice; can be refunded or used as credits) or store (store credits for a customer; needs customer_id). Example: refundable.one of
adjustmentrefundablestore commentstring- Internal comment added to the credit note. Example: Approved by support lead.
create_reason_codestring- Reason code for the credit note, as set up in the Chargebee app under Settings > Reason Codes. Example: Service Unsatisfactory.
currency_codestring- ISO 4217 currency, for a credit note not tied to an invoice on a multi-currency site. Example: USD.
customer_idstring- ID of the customer, for a refundable or store credit note not tied to an invoice. Example: 16BjfNSzYXqA21Dt.
customer_notesstring- Note shown on the customer-facing credit note. Example: Credit for the March outage.
dateinteger- Date of the credit note; defaults to now. Must be on or after the invoice date. Unix timestamp in seconds (UTC). Example: 1735689600.
reference_invoice_idstring- ID of the invoice the credit note is issued against; required for adjustment, and for refundable unless customer_id is set. Example: 1024.
totalinteger- Credit amount in the currency's smallest unit (e.g. 2500 is $25.00). Must not exceed what the referenced invoice allows. Example: 2500.
chargebee_customer_createCreate a customer in Chargebee with contact details, billing address and billing preferences.WriteCreate Customer
Create a customer in Chargebee with contact details, billing address and billing preferences. Returns the new customer object, including its id. Use chargebee_customer_create before creating a subscription for a new buyer. Use chargebee_customer_update to change an existing customer.
Inputs
auto_collectionstring- on to charge the customer's payment method automatically when an invoice is created; off to collect payment manually. Example: on.one of
onoff billing_addressobject- Billing address of the customer. Use any of: first_name, last_name, email, company, phone, line1, line2, line3, city, state_code, state, zip, country (ISO 3166 alpha-2 code). Example: {"line1": "340 S Lemon Ave", "city": "Walnut", "state_code": "CA", "zip": "91789", "country": "US"}.
companystring- Company name of the customer. Example: Acme Inc.
emailstring- Email address of the customer; Chargebee sends billing emails here. Example: jane@acme.com.
first_namestring- First name of the customer. Example: Jane.
idstring- ID for the new customer, up to 50 characters. Chargebee generates one when not set. Example: cust_acme_001.
invoice_notesstring- Note printed on every invoice for this customer. Example: PO 4500012345.
last_namestring- Last name of the customer. Example: Doe.
localestring- Language and region used in emails and hosted pages for the customer. Example: en-US.
meta_datastring- Custom key-value data to store on the record, written as a JSON object in text form. Example: {"crm_id": "0015g00000XyZ"}.
net_term_daysinteger- Number of days after the invoice date that payment is due. Must be one of the net term values set up on the site. Example: 30.
phonestring- Phone number of the customer. Example: +1 415 555 0100.
preferred_currency_codestring- ISO 4217 currency code for the customer, used when multi-currency is enabled on the site. Example: USD.
taxabilitystring- Whether taxes apply to the customer: taxable, exempt or zero_rated. Example: taxable.one of
taxableexemptzero_rated
chargebee_customer_updateUpdate a Chargebee customer's contact details and billing preferences.WriteUpdate Customer
Update a Chargebee customer's contact details and billing preferences. Fields you leave out stay unchanged. Returns the updated customer object. Use chargebee_customer_update to change name, email, auto collection, net terms or metadata. It does not change the billing address or VAT number.
- Idempotent
Inputs
customer_idstringrequired- ID of the customer to update, from chargebee_customers_list. Example: 16BjfNSzYXqA21Dt.
auto_collectionstring- on to charge the customer's payment method automatically when an invoice is created; off to collect payment manually. Example: on.one of
onoff companystring- Company name of the customer. Example: Acme Inc.
emailstring- Email address of the customer; Chargebee sends billing emails here. Example: jane@acme.com.
first_namestring- First name of the customer. Example: Jane.
invoice_notesstring- Note printed on every invoice for this customer. Example: PO 4500012345.
last_namestring- Last name of the customer. Example: Doe.
localestring- Language and region used in emails and hosted pages for the customer. Example: en-US.
meta_datastring- Custom key-value data to store on the record, written as a JSON object in text form. Example: {"crm_id": "0015g00000XyZ"}.
net_term_daysinteger- Number of days after the invoice date that payment is due. Must be one of the net term values set up on the site. Example: 30.
phonestring- Phone number of the customer. Example: +1 415 555 0100.
preferred_currency_codestring- ISO 4217 currency code for the customer, used when multi-currency is enabled on the site. Example: USD.
taxabilitystring- Whether taxes apply to the customer: taxable, exempt or zero_rated. Example: taxable.one of
taxableexemptzero_rated
chargebee_invoice_payment_recordRecord a payment received outside Chargebee (cash, check, bank transfer) against an unpaid invoice.WriteRecord Invoice Payment
Record a payment received outside Chargebee (cash, check, bank transfer) against an unpaid invoice. Returns the updated invoice and the transaction that was created. Use chargebee_invoice_payment_record for offline payments. It does not charge the customer's card.
Inputs
invoice_idstringrequired- ID of the unpaid invoice to record a payment against, from chargebee_invoices_list. Example: 1024.
payment_methodstringrequired- How the payment was received outside Chargebee: cash, check, bank_transfer, other or custom. Example: bank_transfer.one of
cashcheckbank_transferothercustom amountinteger- Amount received, in the currency's smallest unit (e.g. 5000 is $50.00). Defaults to the invoice's amount_due. Example: 5000.
commentstring- Internal remark about the payment. Example: Wire received from Acme.
dateinteger- When the payment was received; defaults to now. Unix timestamp in seconds (UTC). Example: 1735689600.
reference_numberstring- Reference for the payment, such as a check or bank transfer number. Example: CHK-55021.
chargebee_subscription_createCreate a subscription for an existing Chargebee customer from one plan item price plus optional addon and charge item prices.WriteCreate Subscription
Create a subscription for an existing Chargebee customer from one plan item price plus optional addon and charge item prices. Returns the new subscription, the customer and, when charges are raised now, the invoice. Use chargebee_subscription_create for a new subscription. Use chargebee_subscription_update to change items on an existing one. Requires an existing customer (chargebee_customer_create) and item price IDs (chargebee_item_prices_list).
Inputs
customer_idstringrequired- ID of the existing customer to subscribe, from chargebee_customers_list or chargebee_customer_create. Example: 16BjfNSzYXqA21Dt.
subscription_itemsobjectrequired- Item prices on the subscription, written as parallel lists: index 0 of every list describes the first item, index 1 the second, and so on. item_price_id is required for each item; quantity is needed for per-unit prices; unit_price (in the currency's smallest unit, e.g. cents) overrides the catalog price. Exactly one entry must be a plan item price; the rest can be addon or charge item prices. Get IDs from chargebee_item_prices_list. Example: {"item_price_id": ["pro-USD-Monthly", "extra-seats-USD-Monthly"], "quantity": [1, 3]}.
auto_collectionstring- Overrides the customer's auto collection setting for this subscription: on or off. Example: off.one of
onoff billing_cyclesinteger- Number of billing cycles the subscription runs before it stops renewing. Leave empty to renew until cancelled. Example: 12.
coupon_idsarray- Coupon IDs or coupon codes to apply, from chargebee_coupons_list. Example: ["SUMMER20"].
idstring- ID for the new subscription, up to 50 characters. Chargebee generates one when not set. Example: sub_acme_pro.
invoice_immediatelyboolean- Set to true to invoice charges raised now immediately; false adds them to unbilled charges. Defaults to the site setting.
invoice_notesstring- Note printed on invoices for this subscription. Example: Annual contract signed on 2026-01-05.
meta_datastring- Custom key-value data to store on the record, written as a JSON object in text form. Example: {"crm_id": "0015g00000XyZ"}.
po_numberstring- Purchase order number for this subscription. Example: PO-2026-001.
start_dateinteger- When the subscription starts; leave empty to start now. A future date creates a subscription in future status. Unix timestamp in seconds (UTC). Example: 1735689600.
trial_endinteger- When the trial ends, overriding the plan's trial period. Use 0 for no trial. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_subscription_pausePause an active or non-renewing Chargebee subscription now, at term end, on a date, or for a number of billing cycles.WritePause Subscription
Pause an active or non-renewing Chargebee subscription now, at term end, on a date, or for a number of billing cycles. Returns the subscription with status paused, or with pause_date set when scheduled. Use chargebee_subscription_pause to stop renewals temporarily. Use chargebee_subscription_resume to restart it, and chargebee_subscription_cancel to end it.
Inputs
subscription_idstringrequired- ID of the subscription, from chargebee_subscriptions_list. Example: AzZTZgTSz7nCt3Pu.
invoice_dunning_handlingstring- Whether dunning continues or stops for unpaid invoices while paused. Example: continue.one of
continuestop pause_dateinteger- When to pause, if pause_option is specific_date. Unix timestamp in seconds (UTC). Example: 1735689600.
pause_optionstring- When to pause: immediately, end_of_term, specific_date (then set pause_date) or billing_cycles (then set skip_billing_cycles). Example: end_of_term.one of
immediatelyend_of_termspecific_datebilling_cycles resume_dateinteger- When to resume automatically. Leave empty to pause until resumed by hand. Unix timestamp in seconds (UTC). Example: 1735689600.
skip_billing_cyclesinteger- Number of billing cycles to skip, if pause_option is billing_cycles. Example: 2.
unbilled_charges_handlingstring- What to do with unbilled charges when pausing: no_action or invoice. Example: invoice.one of
no_actioninvoice
chargebee_subscription_reactivateReactivate a cancelled Chargebee subscription, now or from a given date, optionally with a new trial.WriteReactivate Subscription
Reactivate a cancelled Chargebee subscription, now or from a given date, optionally with a new trial. Returns the subscription with status active or in_trial, plus any invoice raised. Use chargebee_subscription_reactivate for a cancelled subscription. Use chargebee_subscription_resume for a paused one.
Inputs
subscription_idstringrequired- ID of the subscription, from chargebee_subscriptions_list. Example: AzZTZgTSz7nCt3Pu.
billing_cyclesinteger- Number of billing cycles, including the current one, before the subscription stops renewing. Example: 12.
invoice_immediatelyboolean- Set to true to invoice charges raised now immediately; false adds them to unbilled charges.
reactivate_frominteger- When the reactivation takes effect; leave empty to reactivate now. Can be in the past to backdate. Unix timestamp in seconds (UTC). Example: 1735689600.
trial_endinteger- Set to reactivate the subscription in trial, ending at this time. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_subscription_resumeResume a paused Chargebee subscription now or on a set date.WriteResume Subscription
Resume a paused Chargebee subscription now or on a set date. Returns the subscription, its customer and any invoice raised on resume. Use chargebee_subscription_resume for a paused subscription. Use chargebee_subscription_reactivate for a cancelled one.
Inputs
subscription_idstringrequired- ID of the subscription, from chargebee_subscriptions_list. Example: AzZTZgTSz7nCt3Pu.
charges_handlingstring- How to bill charges raised on resume: invoice_immediately or add_to_unbilled_charges. Example: invoice_immediately.one of
invoice_immediatelyadd_to_unbilled_charges resume_dateinteger- When to resume, if resume_option is specific_date. Unix timestamp in seconds (UTC). Example: 1735689600.
resume_optionstring- When to resume: immediately or specific_date (then set resume_date). Example: immediately.one of
immediatelyspecific_date unpaid_invoices_handlingstring- What to do with unpaid invoices on resume: no_action or schedule_payment_collection. Example: no_action.one of
no_actionschedule_payment_collection
chargebee_subscription_updateChange a Chargebee subscription's item prices, quantities, coupons, trial or billing settings, now or at a scheduled time.WriteUpdate Subscription
Change a Chargebee subscription's item prices, quantities, coupons, trial or billing settings, now or at a scheduled time. Returns the updated subscription, its customer and any invoice or credit notes the change raised. Use chargebee_subscription_update for upgrades, downgrades and quantity changes. Use chargebee_subscription_cancel, _pause or _resume to change its lifecycle.
Inputs
subscription_idstringrequired- ID of the subscription, from chargebee_subscriptions_list. Example: AzZTZgTSz7nCt3Pu.
auto_collectionstring- Overrides the customer's auto collection setting for this subscription: on or off. Example: on.one of
onoff billing_cyclesinteger- New number of billing cycles before the subscription stops renewing. Example: 12.
change_optionstring- When the change takes effect: immediately, end_of_term, or specific_date (then set changes_scheduled_at). Example: immediately.one of
immediatelyend_of_termspecific_date changes_scheduled_atinteger- When the change takes effect, if change_option is specific_date. Unix timestamp in seconds (UTC). Example: 1735689600.
coupon_idsarray- Coupon IDs or codes to apply. Example: ["SUMMER20"].
invoice_immediatelyboolean- Set to true to invoice charges raised by the change now; false adds them to unbilled charges.
invoice_notesstring- Note printed on invoices for this subscription. Example: Upgraded to Pro.
meta_datastring- Custom key-value data to store on the record, written as a JSON object in text form. Example: {"crm_id": "0015g00000XyZ"}.
po_numberstring- Purchase order number for this subscription. Example: PO-2026-002.
prorateboolean- For a mid-term change, true raises prorated credits and charges; false does not. Defaults to the site setting.
replace_coupon_listboolean- Set to true to replace the existing coupons with coupon_ids; false (default) adds to them.
replace_items_listboolean- Set to true to replace all existing items with subscription_items; false (default) adds or updates only the items you pass.
subscription_itemsobject- Item prices on the subscription, written as parallel lists: index 0 of every list describes the first item, index 1 the second, and so on. item_price_id is required for each item; quantity is needed for per-unit prices; unit_price (in the currency's smallest unit, e.g. cents) overrides the catalog price. Items you pass are added or updated; set replace_items_list to true to replace the whole list. Get IDs from chargebee_item_prices_list. Example: {"item_price_id": ["pro-USD-Monthly", "extra-seats-USD-Monthly"], "quantity": [1, 3]}.
trial_endinteger- New trial end time. Use 0 to end the trial now. Unix timestamp in seconds (UTC). Example: 1735689600.
chargebee_invoice_voidVoid a Chargebee invoice so it is no longer payable.DestructiveVoid Invoice
Void a Chargebee invoice so it is no longer payable. Voiding cannot be undone. Returns the invoice with status voided and any credit note raised. Use chargebee_invoice_void to cancel an invoice raised in error. Use chargebee_credit_note_create to credit part of a paid invoice instead.
Inputs
invoice_idstringrequired- ID of the invoice to void, from chargebee_invoices_list. Example: 1024.
commentstring- Internal comment added to the invoice for this action. Example: Duplicate invoice.
void_reason_codestring- Void reason code, as set up in the Chargebee app under Settings > Reason Codes. Example: Duplicate.
chargebee_subscription_cancelCancel a Chargebee subscription now, at the end of the term, or on a set date, with options for credits and unpaid invoices.DestructiveCancel Subscription
Cancel a Chargebee subscription now, at the end of the term, or on a set date, with options for credits and unpaid invoices. Returns the subscription with status cancelled or non_renewing, plus any invoice or credit notes raised. Use chargebee_subscription_cancel to end a subscription. Use chargebee_subscription_pause to stop billing temporarily, and chargebee_subscription_reactivate to restart a cancelled one.
Inputs
subscription_idstringrequired- ID of the subscription, from chargebee_subscriptions_list. Example: AzZTZgTSz7nCt3Pu.
account_receivables_handlingstring- What to do with unpaid invoices: no_action, schedule_payment_collection or write_off. Example: no_action.one of
no_actionschedule_payment_collectionwrite_off cancel_atinteger- When to cancel, if cancel_option is specific_date. Unix timestamp in seconds (UTC). Example: 1735689600.
cancel_optionstring- When to cancel: immediately, end_of_term, specific_date (then set cancel_at) or end_of_billing_term. Defaults to immediately. Example: end_of_term.one of
immediatelyend_of_termspecific_dateend_of_billing_term cancel_reason_codestring- Cancellation reason code, as set up in the Chargebee app under Settings > Reason Codes. Example: Not Satisfied.
credit_option_for_current_term_chargesstring- Credit to give for the unused part of the current term when cancelling immediately: none, prorate, full or consumption_based. Example: prorate.one of
noneproratefullconsumption_based refundable_credits_handlingstring- What to do with the customer's refundable credits: no_action or schedule_refund. Example: no_action.one of
no_actionschedule_refund unbilled_charges_optionstring- What to do with unbilled charges: invoice them now or delete them. Example: invoice.one of
invoicedelete
No tools match.