NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #4223 most downloaded on PyPI
Python wrapper for the Chargebee Subscription Billing API
Last release 10 days ago
24 Sep 2026
Ships fairly regularly
a new release about every 3 weeks
Most releases are documented
notes for 51 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
14 years old
257 releases · first in 2012
granted_amount has been deprecated in GrantBlock .
AppliedBusinessRule has been added.AppliedRule has been added.ApplyRule has been added.BusinessRule has been added.BusinessRuleset has been added.BusinessRulesetRule has been added.CustomDataSchema has been added.Dispute has been added.EmailLog has been added.send_credit_note_email has been added to CreditNote.send_payment_request_email has been added to Customer.list_e-invoices has been added to Einvoice.retrieve_an_e-invoice has been added to Einvoice.send_invoice_email has been added to Invoice.list_payment_schedules has been added to PaymentSchedule.list_payment_schedule_schemes has been added to PaymentScheduleScheme.brand_id has been added to CreditNote.brand_id has been added to Customer.entity_type has been added to Einvoice.entity_id has been added to Einvoice.created_at has been added to Einvoice.resource_version has been added to Einvoice.updated_at has been added to Einvoice.deleted has been added to Einvoice.business_entity_id has been added to Einvoice.artifacts has been added to Einvoice.site_id has been added to Event.provisioned_block_balance has been added to GrantBlock.overdraft_block_balance has been added to GrantBlock.brand_id has been added to HostedPage.brand_id has been added to Invoice.brand_id has been added to PaymentIntent.reference_transactions has been added to PaymentSchedule.brand_id has been added to PaymentSource.network_transaction_reference has been added to PaymentSource.billing_configuration has been added to Ramp.brand_id has been added to Subscription.network_transaction_reference has been added to ThirdPartyPaymentMethod.network_transaction_details has been added to Transaction.limit has been added as query parameter to list_e-invoices in Einvoice.offset has been added as query parameter to list_e-invoices in Einvoice.id has been added as query parameter to list_e-invoices in Einvoice.reference_id has been added as query parameter to list_e-invoices in Einvoice.updated_at has been added as query parameter to list_e-invoices in Einvoice.sort_by has been added as query parameter to list_e-invoices in Einvoice.invoice_id has been added as query parameter to list_e-invoices in Einvoice.credit_note_id has been added as query parameter to list_e-invoices in Einvoice.limit has been added as query parameter to list_payment_schedules in PaymentSchedule.offset has been added as query parameter to list_payment_schedules in PaymentSchedule.invoice_id has been added as query parameter to list_payment_schedules in PaymentSchedule.id has been added as query parameter to list_payment_schedules in PaymentSchedule.updated_at has been added as query parameter to list_payment_schedules in PaymentSchedule.limit has been added as query parameter to list_payment_schedule_schemes in PaymentScheduleScheme.offset has been added as query parameter to list_payment_schedule_schemes in PaymentScheduleScheme.id has been added as query parameter to list_payment_schedule_schemes in PaymentScheduleScheme.updated_at has been added as query parameter to list_payment_schedule_schemes in PaymentScheduleScheme.line_items.is_partial_tax_applied has been added as request body parameter to import_credit_note in CreditNote.line_items.taxable_amount has been added as request body parameter to import_credit_note in CreditNote.brand_id has been added as request body parameter to create_a_customer in Customer.subscription_items.description has been added as request body parameter to estimate_for_creating_a_customer_and_subscription in Estimate.subscription_items.description has been added as request body parameter to estimate_for_updating_a_subscription in Estimate.subscription_items.description has been added as request body parameter to estimate_for_creating_a_subscription in Estimate.brand_id has been added as request body parameter to checkout_charge-items_and_one-time_charges in HostedPage.brand_id has been added as request body parameter to extend_subscription in HostedPage.brand_id has been added as request body parameter to checkout_gift_subscription_for_items in HostedPage.brand_id has been added as request body parameter to collect_now in HostedPage.brand_id has been added as request body parameter to accept_a_quote in HostedPage.brand_id has been added as request body parameter to create_checkout_for_a_new_subscription in HostedPage.brand_id has been added as request body parameter to claim_a_gift_subscription in HostedPage.brand_id has been added as request body parameter to create_checkout_to_update_a_subscription in HostedPage.brand_id has been added as request body parameter to create_a_pre-cancel_hosted_page in HostedPage.brand_id has been added as request body parameter to manage_payment_sources in HostedPage.line_items.is_partial_tax_applied has been added as request body parameter to import_invoice in Invoice.line_items.taxable_amount has been added as request body parameter to import_invoice in Invoice.id has been added as request body parameter to allocate in LedgerOperation.effective_from has been added as request body parameter to allocate in LedgerOperation.brand_id has been added as request body parameter to create_a_payment_intent in PaymentIntent.brand_id has been added as request body parameter to create_using_permanent_token in PaymentSource.brand_id has been added as request body parameter to create_a_card_payment_source in PaymentSource.brand_id has been added as request body parameter to create_using_payment_intent in PaymentSource.brand_id has been added as request body parameter to create_a_voucher_payment_method in PaymentSource.brand_id has been added as request body parameter to create_using_gateway_temporary_token in PaymentSource.network_transaction_reference has been added as request body parameter to update_a_card_payment_source in PaymentSource.brand_id has been added as request body parameter to create_using_chargebee_token in PaymentSource.brand_id has been added as request body parameter to create_a_bank_account_payment_source in PaymentSource.brand_id has been added as request body parameter to create_pricing_page_for_new_subscription in PricingPageSession.id has been added as request body parameter to create_promotional_grant in PromotionalGrant.effective_from has been added as request body parameter to create_promotional_grant in PromotionalGrant.billing_configuration has been added as request body parameter to create_a_ramp in Ramp.billing_configuration has been added as request body parameter to update_a_subscription_ramp in Ramp.subscription_items.description has been added as request body parameter to update_subscription_for_items in Subscription.brand_id has been added as request body parameter to create_a_subscription in Subscription.brand_id has been added as request body parameter to create_subscription_for_customer in Subscription.subscription_items.description has been added as request body parameter to import_subscription_for_items in Subscription.subscription_items.description has been added as request body parameter to create_subscription_for_items in Subscription.brand_id has been added as request body parameter to create_subscription_for_items in Subscription.business_rule_deleted has been added.business_rules_applied has been added.business_ruleset_updated has been added.business_rule_created has been added.einvoice_created has been added.business_ruleset_deactivated has been added.business_ruleset_deleted has been added.business_ruleset_created has been added.business_ruleset_activated has been added.business_rule_deactivated has been added.einvoice_updated has been added.business_rule_released has been added.business_rule_activated has been added.business_rule_updated has been added.business_ruleset and price_ramp have been added as new values enum EntityType.einvoice_created, einvoice_updated, business_rule_created, business_rule_updated, business_rule_activated, business_rule_deactivated, business_rule_deleted, business_rule_released, business_rules_applied, business_ruleset_created, business_ruleset_updated, business_ruleset_activated, business_ruleset_deactivated, and business_ruleset_deleted have been added as new values enum EventType.payu has been added as a new value enum Gateway.payu has been added as a new value enum GatewayName.blik, fpx, wero, p24, ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, affirm_pay, and rakuten_pay have been added as new values enum PaymentMethod.ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, and rakuten_pay have been added as new values enum PaymentMethodType.rescheduled, succeeded, failed, deferred, delivered, opened, bounced, and dropped have been added as new values enum Status.zero_rated has been added as a new value enum Taxability.ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, and rakuten_pay have been added as new values enum Type.cpq_quote has been added as a new value to enum attribute entity_type in AppliedBusinessRule.stop_on_first_true, stop_on_first_false, execute_all, and execute_all_true have been added as new values to enum attribute execute_mode in BusinessRuleset.active and archived have been added as new values to enum attribute status in CustomDataSchema.initiated, funds_withdrawn, in_review, cancelled, lost, and won have been added as new values to enum attribute status in Dispute.chargeback and inquiry have been added as new values to enum attribute type in Dispute.invoice and credit_note have been added as new values to enum attribute entity_type in Einvoice.overdraft_settlement has been added as a new value to enum attribute type in LedgerOperation.subscription_not_found_in_source has been added as a new value to enum attribute expiration_reason in OmnichannelSubscriptionItem.ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, and rakuten_pay have been added as new values to enum attribute payment_method_type in PaymentIntent.ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, and rakuten_pay have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.true and false have been added as new values to enum query parameter draft.is in list_business_rules of BusinessRule.true and false have been added as new values to enum query parameter active.is in list_business_rules of BusinessRule.stop_on_first_true, stop_on_first_false, execute_all, and execute_all_true have been added as new values to enum request body parameter execute_mode in update_a_business_ruleset of BusinessRuleset.true and false have been added as new values to enum query parameter active.is in list_rules_in_a_business_ruleset of BusinessRuleset.true and false have been added as new values to enum query parameter active.is in list_business_rulesets of BusinessRuleset.stop_on_first_true, stop_on_first_false, execute_all, and execute_all_true have been added as new values to enum request body parameter execute_mode in create_a_business_ruleset of BusinessRuleset.dankort has been added as a new value to enum request body parameter preferred_scheme in update_card_for_a_customer of Card.dankort has been added as a new value to enum request body parameter card.preferred_scheme in create_a_customer of Customer.dankort has been added as a new value to enum request body parameter card.preferred_scheme in collect_payment_for_customer of Customer.initiated, in_review, lost, funds_withdrawn, won, and cancelled have been added as new values to enum query parameter status.is in list_disputes of Dispute.initiated, in_review, lost, funds_withdrawn, won, and cancelled have been added as new values to enum query parameter status.is_not in list_disputes of Dispute.initiated, in_review, lost, funds_withdrawn, won, and cancelled have been added as new values to enum query parameter status.in in list_disputes of Dispute.initiated, in_review, lost, funds_withdrawn, won, and cancelled have been added as new values to enum query parameter status.not_in in list_disputes of Dispute.inquiry and chargeback have been added as new values to enum query parameter type.is in list_disputes of Dispute.inquiry and chargeback have been added as new values to enum query parameter type.is_not in list_disputes of Dispute.inquiry and chargeback have been added as new values to enum query parameter type.in in list_disputes of Dispute.inquiry and chargeback have been added as new values to enum query parameter type.not_in in list_disputes of Dispute.updated_at has been added as a new value to enum query parameter sort_by.asc in list_e-invoices of Einvoice.updated_at has been added as a new value to enum query parameter sort_by.desc in list_e-invoices of Einvoice.dankort has been added as a new value to enum request body parameter card.preferred_scheme in create_an_invoice of Invoice.dankort has been added as a new value to enum request body parameter card.preferred_scheme in create_invoice_for_items_and_one-time_charges of Invoice.overdraft_settlement has been added as a new value to enum query parameter type.is in list_ledger_operations of LedgerOperation.overdraft_settlement has been added as a new value to enum query parameter type.in in list_ledger_operations of LedgerOperation.ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, and rakuten_pay have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.ovo, momo, mercado_pago, nequi, nupay, picpay, thai_qr, blik, fpx, wero, p24, affirm_pay, and rakuten_pay have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.dankort has been added as a new value to enum request body parameter card.preferred_scheme in create_a_card_payment_source of PaymentSource.dankort has been added as a new value to enum request body parameter card.preferred_scheme in update_subscription_for_items of Subscription.dankort has been added as a new value to enum request body parameter card.preferred_scheme in create_a_subscription of Subscription.dankort has been added as a new value to enum request body parameter card.preferred_scheme in update_a_subscription of Subscription.dankort has been added as a new value to enum request body parameter card.preferred_scheme in import_a_subscription of Subscription.granted_amount has been deprecated in GrantBlock.balance has been deprecated in GrantBlock.hold_amount has been deprecated in GrantBlock.used_amount has been deprecated in GrantBlock.expired_amount has been deprecated in GrantBlock.rolled_over_amount has been deprecated in GrantBlock.voided_amount has been deprecated in GrantBlock.One column per quarter.
GatewayPaymentMethodToken has been added.
GatewayPaymentMethodToken has been added.OmnichannelSubscriptionItemMetric has been added.QuoteEntitlement has been added.VaultedPaymentMethod has been added.update_credit_note_details has been added to CreditNote.export_subscription_ramps has been added to Export.void_authorizations_before_capture has been added to Invoice.list_gateway_payment_method_tokens_for_a_payment_source has been added to PaymentSource.payment_method_options has been added to PaymentIntent.vault_token has been added to PaymentSource.has_entitlements has been added to Quote.updated_at.on has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.updated_at.between has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.purchased_at.on has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.purchased_at.between has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.limit has been added as query parameter to list_gateway_payment_method_tokens_for_a_payment_source in PaymentSource.offset has been added as query parameter to list_gateway_payment_method_tokens_for_a_payment_source in PaymentSource.include_deleted has been added as query parameter to list_gateway_payment_method_tokens_for_a_payment_source in PaymentSource.comment has been added as request body parameter to update_credit_note_details in CreditNote.ramp has been added as request body parameter to export_subscription_ramps in Export.export_type has been added as request body parameter to export_subscription_ramps in Export.locale has been added as request body parameter to create_a_pre-cancel_hosted_page in HostedPage.comment has been added as request body parameter to void_authorizations_before_capture in Invoice.void_reason_code has been added as request body parameter to void_authorizations_before_capture in Invoice.invoice_action has been added as request body parameter to void_authorizations_before_capture in Invoice.payment_method_options has been added as request body parameter to update_a_payment_intent in PaymentIntent.payment_method_options has been added as request body parameter to create_a_payment_intent in PaymentIntent.subscription_items.description has been added as request body parameter to create_a_quote_for_a_new_subscription_items in Quote.entitlement_overrides has been added as request body parameter to create_a_quote_for_a_new_subscription_items in Quote.subscription_items.description has been added as request body parameter to edit_update_subscription_quote_for_items in Quote.entitlement_overrides has been added as request body parameter to edit_update_subscription_quote_for_items in Quote.subscription_items.description has been added as request body parameter to edit_create_subscription_quote_for_items in Quote.entitlement_overrides has been added as request body parameter to edit_create_subscription_quote_for_items in Quote.subscription_items.description has been added as request body parameter to create_a_quote_for_update_subscription_items in Quote.entitlement_overrides has been added as request body parameter to create_a_quote_for_update_subscription_items in Quote.vault_token_updated has been added.vault_token_deleted has been added.omnichannel_subscription_item_mrr_updated has been added.vault_token_created has been added.consumption_based has been added as a new value enum CreditOptionForCurrentTermCharges.omnichannel_subscription_item_metric has been added as a new value enum EntityType.omnichannel_subscription_item_mrr_updated, vault_token_created, vault_token_updated, and vault_token_deleted have been added as new values enum EventType.chargebee, chargebee_payments, adyen, stripe, wepay, braintree, authorize_net, paypal_pro, pin, eway, eway_rapid, worldpay, balanced_payments, beanstream, bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, wirecard, amazon_payments, paypal_express_checkout, gocardless, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, checkout_com, paypal, ingenico_direct, exact, mollie, quickbooks, razorpay, global_payments, bank_of_america, ecentric, metrics_global, windcave, pay_com, ebanx, dlocal, nuvei, solidgate, paystack, jp_morgan, deutsche_bank, ezidebit, twikey, tempus, moyasar, payway, and not_applicable have been added as new values enum GatewayName.void and write_off have been added as new values enum InvoiceAction.active, inactive, and pending_verification have been added as new values to enum attribute status in GatewayPaymentMethodToken.payment_method_helper, card_components, checkout, collect_now, portal, and payment_components have been added as new values to enum attribute payment_intent_metadata.source in PaymentIntent.plan_price, addon_price, charge_price, and charge have been added as new values to enum attribute entity_type in QuoteEntitlement.upsert and remove have been added as new values to enum attribute action_type in QuoteEntitlement.allocate has been added to LedgerOperation .
CreditUnit has been added.LedgerEntry has been added.allocate has been added to LedgerOperation.unit_id has been added to Alert.subscription_id has been added to GrantBlock.modified_at has been added to GrantBlock.resource_version has been added to GrantBlock.created_at has been added to LedgerAccountBalance.resource_version has been added to LedgerAccountBalance.account_type has been added as query parameter to list_grant_blocks in GrantBlock.unit_id has been added as request body parameter to create_an_alert in Alert.include_cancellation_day_in_billing has been added as request body parameter to cancel_subscription_for_items_estimate in Estimate.subscription_id has been added as request body parameter to allocate in LedgerOperation.unit_id has been added as request body parameter to allocate in LedgerOperation.amount has been added as request body parameter to allocate in LedgerOperation.expires_at has been added as request body parameter to allocate in LedgerOperation.metadata has been added as request body parameter to allocate in LedgerOperation.include_cancellation_day_in_billing has been added as request body parameter to cancel_subscription_for_items in Subscription.grant_blocks_created has been added.ledger_updated has been added.ledger_account_balance_updated has been added.grant_blocks_updated has been added.ledger_account_balance_updated, grant_blocks_created, grant_blocks_updated, and ledger_updated have been added as new values enum EventType.dana, touch_n_go, tamara, and qpay have been added as new values enum PaymentMethod.dana, touch_n_go, tamara, and qpay have been added as new values enum PaymentMethodType.dana, touch_n_go, tamara, qpay, credit_balance_dropped, credit, debit, hold, and unhold have been added as new values enum Type.active and archived have been added as new values to enum attribute status in CreditUnit.grant_renewal and subscription_renewed have been added as new values to enum attribute grant_source in GrantBlock.provisioned and overdraft have been added as new values to enum attribute account_type in LedgerEntry.credit_unit has been added as a new value to enum attribute unit_type in LedgerEntry.dana, touch_n_go, tamara, and qpay have been added as new values to enum attribute payment_method_type in PaymentIntent.dana, touch_n_go, tamara, and qpay have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.archived and active have been added as new values to enum query parameter status.in in list_credit_units of CreditUnit.archived and active have been added as new values to enum query parameter status.is in list_credit_units of CreditUnit.provisioned and overdraft have been added as new values to enum query parameter account_type.is in list_grant_blocks of GrantBlock.dana, touch_n_go, tamara, and qpay have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.dana, touch_n_go, tamara, and qpay have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.AsyncResponseList has been added.
AsyncResponse has been added.AsyncResponseList has been added.ColumnDefinition has been added.Meter has been added.MeteredFeature has been added.currency_code has been added to Alert.threshold has been added to Alert.filter_conditions has been added to Alert.exchange_rates has been added to CreditNote.metered has been added to Feature.exchange_rates has been added to Invoice.payment_intent_metadata has been added to PaymentIntent.metered has been added as query parameter to list_features in Feature.decommissioned has been added as query parameter to list_subscriptions in Subscription.currency_code has been added as request body parameter to create_an_alert in Alert.line_items.proration_mode has been added as request body parameter to import_credit_note in CreditNote.item_prices.description has been added as request body parameter to create_invoice_for_items_estimate in Estimate.item_prices.entity_description has been added as request body parameter to create_invoice_for_items_estimate in Estimate.charges.entity_description has been added as request body parameter to create_invoice_for_items_estimate in Estimate.subscription.decommissioned has been added as request body parameter to export_subscriptions in Export.item_prices.description has been added as request body parameter to create_invoice_for_items_and_one-time_charges in Invoice.item_prices.entity_description has been added as request body parameter to create_invoice_for_items_and_one-time_charges in Invoice.charges.entity_description has been added as request body parameter to create_invoice_for_items_and_one-time_charges in Invoice.create_pending_invoice has been added as request body parameter to create_invoice_for_items_and_one-time_charges in Invoice.line_items.proration_mode has been added as request body parameter to import_invoice in Invoice.paid_at has been added as request body parameter to import_invoice in Invoice.discounts_to_add.quantity has been added as request body parameter to create_a_ramp in Ramp.discounts_to_add.quantity has been added as request body parameter to update_a_subscription_ramp in Ramp.customer.email has been added as request body parameter to record_a_purchase in RecordedPurchase.customer.first_name has been added as request body parameter to record_a_purchase in RecordedPurchase.customer.last_name has been added as request body parameter to record_a_purchase in RecordedPurchase.metered_feature_id has been changed from required to optional in create_an_alert of Alert.payment_source_business_entity_changed has been added.start_balance has been removed from LedgerOperation.end_balance has been removed from LedgerOperation.real_time_payments has been added as a new value enum DunningType.payment_source_business_entity_changed has been added as a new value enum EventType.paynow, bizum, and promptpay have been added as new values enum PaymentMethod.paynow, bizum, and promptpay have been added as new values enum PaymentMethodType.active, archived, and deleted have been added as new values enum Status.zero_rated, region_non_taxable, product_exempt, high_value_physical_goods, zero_value_item, and tax_not_configured_external_provider have been added as new values enum TaxOverrideReason.paynow, bizum, promptpay, simple, compound, and spend_exceeded have been added as new values enum Type.success and failed have been added as new values to enum attribute status in AsyncResponse.number and string have been added as new values to enum attribute data_type in ColumnDefinition.simple and compound have been added as new values to enum attribute type in Meter.active, archived, and deleted have been added as new values to enum attribute status in Meter.paynow, bizum, and promptpay have been added as new values to enum attribute payment_method_type in PaymentIntent.paynow, bizum, and promptpay have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.cb_js, components_fields, checkout_v3, paynow_v3, portal_v3, gift_v3, checkout_v4, payment_component, pc_inapp_v4, and pc_fpc_v4 have been added as new values to enum attribute payment_intent_metadata.source in PaymentIntent.adjusted_term, service_period_revision, delta, and reset have been added as new values to enum request body parameter line_items.proration_mode in import_credit_note of CreditNote.true and false have been added as new values to enum query parameter metered.is in list_features of Feature.adjusted_term, service_period_revision, delta, and reset have been added as new values to enum request body parameter line_items.proration_mode in import_invoice of Invoice.updated_at, name, created_at, and id have been added as new values to enum query parameter sort_by.asc in list_all_available_meters of Meter.updated_at, name, created_at, and id have been added as new values to enum query parameter sort_by.desc in list_all_available_meters of Meter.number and string have been added as new values to enum request body parameter column_definitions.data_type in create_a_metered_feature of MeteredFeature.paynow, bizum, and promptpay have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.paynow, bizum, and promptpay have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.true and false have been added as new values to enum query parameter decommissioned.is in list_subscriptions of Subscription.Added an optional telemetry adapter hook for tracing Chargebee API calls via OpenTelemetry (or any APM). Configure it via Chargebee(..., telemetry_ada
Chargebee(..., telemetry_adapter=adapter). When unconfigured, the SDK skips all telemetry work — no behavior change for existing integrations.chargebee.{resource}.{operation}) with OpenTelemetry HTTP semantic-convention attributes plus chargebee.* attributes. Adapters may inject W3C trace context (traceparent) into outbound request headers for distributed tracing.TelemetryAdapter, RequestTelemetryContext, RequestTelemetryResult, RequestTelemetryError), the TelemetrySupport helpers, and the TelemetryAttributeKeys constants under chargebee.telemetry. OpenTelemetry is not bundled with the SDK; bring your own OTel packages in the host application.LedgerAccountBalance has been added.
GrantBlock has been added.LedgerAccountBalance has been added.LedgerOperation has been added.PromotionalGrant has been added.notes has been added to CreditNote.layout has been added to HostedPage.sort_by has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.available, exhausted, scheduled, and in_grace_period have been added as new values enum Status.subscription_created, subscription_changed, top_up, promotional_grants, and rollover have been added as new values to enum attribute grant_source in GrantBlock.provisioned and overdraft have been added as new values to enum attribute account_type in GrantBlock.credit_unit has been added as a new value to enum attribute unit_type in GrantBlock.credit_unit has been added as a new value to enum attribute unit_type in LedgerAccountBalance.allocation, capture, authorize, release_authorization, capture_authorization, expiry, void, rollover, and adjustment have been added as new values to enum attribute type in LedgerOperation.credit_unit has been added as a new value to enum attribute unit_type in LedgerOperation.expires_at, created_at, and effective_from have been added as new values to enum query parameter sort_by.asc in list_grant_blocks of GrantBlock.expires_at, created_at, and effective_from have been added as new values to enum query parameter sort_by.desc in list_grant_blocks of GrantBlock.allocation, release_authorization, void, capture, rollover, adjustment, expiry, authorize, and capture_authorization have been added as new values to enum query parameter type.is in list_ledger_operations of LedgerOperation.allocation, release_authorization, void, capture, rollover, adjustment, expiry, authorize, and capture_authorization have been added as new values to enum query parameter type.in in list_ledger_operations of LedgerOperation.created_at has been added as a new value to enum query parameter sort_by.asc in list_ledger_operations of LedgerOperation.created_at has been added as a new value to enum query parameter sort_by.desc in list_ledger_operations of LedgerOperation.updated_at and created_at have been added as new values to enum query parameter sort_by.asc in list_omnichannel_subscriptions of OmnichannelSubscription.updated_at and created_at have been added as new values to enum query parameter sort_by.desc in list_omnichannel_subscriptions of OmnichannelSubscription.purchased_at has been added to OmnichannelSubscription .
purchased_at has been added to OmnichannelSubscription.updated_at has been added to OmnichannelSubscription.updated_at has been added to OmnichannelSubscriptionItem.customer_id.in has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.customer_id.not_in has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.id has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.id_at_source has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.updated_at has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.purchased_at has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.gift_receiver has been added as request body parameter to update_a_gift in Gift.layout has been added as request body parameter to checkout_gift_subscription_for_items in HostedPage.scheduled_at has been changed from required to optional in update_a_gift of Gift.omnichannel_subscription_item_updated has been added.omnichannel_subscription_item_recovered has been added.entity_id has been removed from QuoteEntitlement.entity_type has been removed from QuoteEntitlement.feature_id has been removed from QuoteEntitlement.value has been removed from QuoteEntitlement.is_enabled has been removed from QuoteEntitlement.start_date has been removed from QuoteEntitlement.end_date has been removed from QuoteEntitlement.created_at has been removed from QuoteEntitlement.modified_at has been removed from QuoteEntitlement.exclude has been removed as query parameter from list_invoices in Invoice.omnichannel_subscription_item_updated and omnichannel_subscription_item_recovered have been added as new values enum EventType.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values enum PaymentMethod.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values enum PaymentMethodType.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values enum Type.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values to enum attribute payment_method_type in PaymentIntent.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.klarna, alipay_hk, paypay, gcash, and south_korean_cards have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.Fixed an inconsistency in required parameters for API methods between the SDK Generator and OpenAPI specifications.
QuoteEntitlement has been added.
QuoteEntitlement has been added.list_applicable_alerts_for_a_subscription has been added to Alert.retrieve_an_alert has been added to Alert.update_an_alert has been added to Alert.delete_an_alert has been added to Alert.list_alerts has been added to Alert.create_an_alert has been added to Alert.list_alert_statuses_for_a_subscription has been added to AlertStatus.list_alert_statuses_for_an_alert has been added to AlertStatus.alarm_status has been added to AlertStatus.limit has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.offset has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.status has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.type has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.limit has been added as query parameter to list_alerts in Alert.offset has been added as query parameter to list_alerts in Alert.id has been added as query parameter to list_alerts in Alert.type has been added as query parameter to list_alerts in Alert.subscription_id has been added as query parameter to list_alerts in Alert.status has been added as query parameter to list_alerts in Alert.limit has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.offset has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.alarm_status has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.alert_id has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.limit has been added as query parameter to list_alert_statuses_for_an_alert in AlertStatus.offset has been added as query parameter to list_alert_statuses_for_an_alert in AlertStatus.alarm_status has been added as query parameter to list_alert_statuses_for_an_alert in AlertStatus.exclude has been added as query parameter to list_invoices in Invoice.threshold has been added as request body parameter to update_an_alert in Alert.status has been added as request body parameter to update_an_alert in Alert.threshold has been added as request body parameter to create_an_alert in Alert.filter_conditions has been added as request body parameter to create_an_alert in Alert.type has been added as request body parameter to create_an_alert in Alert.name has been added as request body parameter to create_an_alert in Alert.description has been added as request body parameter to create_an_alert in Alert.metered_feature_id has been added as request body parameter to create_an_alert in Alert.subscription_id has been added as request body parameter to create_an_alert in Alert.meta has been added as request body parameter to create_an_alert in Alert.defer_payment_method_type has been added as request body parameter to create_a_payment_intent in PaymentIntent.net_term_days has been added as request body parameter to edit_quote_for_charge_items_and_charges in Quote.net_term_days has been added as request body parameter to create_a_quote_for_charge_and_charge_items in Quote.alarm_triggered_at has been removed from Alert.scope has been removed from Alert.alert_status has been removed from AlertStatus.within_limit and in_alarm have been added as new values enum AlarmStatus.moyasar and payway have been added as new values enum Gateway.absolute and percentage have been added as new values enum Mode.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values enum PaymentMethod.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values enum PaymentMethodType.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values enum Type.mada has been added as a new value to enum attribute card_type in Card.rate_limited has been added as a new value to enum attribute webhook_status in Event.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum attribute payment_method_type in PaymentIntent.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.mada has been added as a new value to enum attribute card.brand in PaymentSource.plan_price, addon_price, charge_price, and charge have been added as new values to enum attribute entity_type in QuoteEntitlement.disabled and enabled have been added as new values to enum query parameter status.is in list_applicable_alerts_for_a_subscription of Alert.enabled and disabled have been added as new values to enum request body parameter status in update_an_alert of Alert.disabled and enabled have been added as new values to enum query parameter status.is in list_alerts of Alert.plan_price_id has been added as a new value to enum request body parameter filter_conditions.field in create_an_alert of Alert.not_equals and equals have been added as new values to enum request body parameter filter_conditions.operator in create_an_alert of Alert.rate_limited has been added as a new value to enum query parameter webhook_status.is in list_events of Event.rate_limited has been added as a new value to enum query parameter webhook_status.is_not in list_events of Event.rate_limited has been added as a new value to enum query parameter webhook_status.in in list_events of Event.rate_limited has been added as a new value to enum query parameter webhook_status.not_in in list_events of Event.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.mada has been added as a new value to enum request body parameter card.brand in create_using_permanent_token of PaymentSource.CpqQuoteSignature has been added.
Alert has been added.AlertStatus has been added.CpqQuoteSignature has been added.update_a_quote_signature_status has been added to Quote.update_a_quote_signature has been added to Quote.retrieve_a_quote_signature_signed_pdf has been added to Quote.retrieve_a_quote_signature has been added to Quote.create_a_quote_signature has been added to Quote.refresh_a_quote_signature_link has been added to Quote.reference_id has been added to Einvoice.provider_references has been added to Einvoice.created_at has been added to UnbilledCharge.include_usage_charges has been added as query parameter to upcoming_invoices_estimate in Estimate.business_entity_id has been added as request body parameter to manage_payment_sources in HostedPage.cpq_quote_signature has been added as request body parameter to update_a_quote_signature_status in Quote.gateway_account_id has been added as request body parameter to create_a_virtual_bank_account in VirtualBankAccount.gateway_account_id has been added as request body parameter to create_a_virtual_bank_account_using_permanent_token in VirtualBankAccount.alert_status_changed has been added.alert_status has been added as a new value enum EntityType.alert_status_changed has been added as a new value enum EventType.pix has been added as a new value enum PaymentMethod.pix has been added as a new value enum PaymentMethodType.pix and usage_exceeded have been added as new values enum Type.enabled and disabled have been added as new values to enum attribute status in Alert.global and subscription have been added as new values to enum attribute scope in Alert.draft, active, signed, expired, cancelled, and declined have been added as new values to enum attribute status in CpqQuoteSignature.esign_and_pay, esign, and pay have been added as new values to enum attribute customer_acceptance_method in CpqQuoteSignature.consolidated and detailed have been added as new values to enum attribute quote_type in CpqQuoteSignature.pix has been added as a new value to enum attribute payment_method_type in PaymentIntent.pix has been added as a new value to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.pix has been added as a new value to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.pix has been added as a new value to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.expired, declined, draft, active, signed, and cancelled have been added as new values to enum request body parameter cpq_quote_signature.status in update_a_quote_signature_status of Quote.Fixed URL construction to avoid appending a trailing ? when there are no query parameters.
? when there are no query parameters.`free_period` has been added to `QuotedSubscription`.
UsageCharge has been added.UsageSummary has been added.free_period has been added to QuotedSubscription.free_period_unit has been added to QuotedSubscription.net_term_days has been added as request body parameter to create_invoice_for_items_and_one-time_charges in Invoice.contract_term has been added as request body parameter to create_pricing_page_for_existing_subscription in PricingPageSession.contract_term has been added as request body parameter to create_pricing_page_for_new_subscription in PricingPageSession.subscription.free_period has been added as request body parameter to create_a_quote_for_a_new_subscription_items in Quote.subscription.free_period_unit has been added as request body parameter to create_a_quote_for_a_new_subscription_items in Quote.subscription.free_period has been added as request body parameter to edit_create_subscription_quote_for_items in Quote.subscription.free_period_unit has been added as request body parameter to edit_create_subscription_quote_for_items in Quote.month, week, day, hour, and minute have been added as new values enum WindowSize.cancel, renew_once, renew, and evergreen have been added as new values to enum request body parameter contract_term.action_at_term_end in create_pricing_page_for_existing_subscription of PricingPageSession.cancel, renew_once, renew, and evergreen have been added as new values to enum request body parameter contract_term.action_at_term_end in create_pricing_page_for_new_subscription of PricingPageSession.corrected the response schema for `add_item_entitlement`.
add_item_entitlement.upsert_or_remove_item_entitlements_for_item.Fixed enum serialization in JSON requests to use actual enum values instead of string representations.
`subscription_id` has been added to `EntitlementOverride`.
subscription_id has been added to EntitlementOverride.is_enabled has been added to EntitlementOverride.decommissioned has been added to Subscription.omnichannel_subscription_item has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.entitlement_overrides.entity_id has been added as request body parameter to upsert_or_remove_entitlement_overrides_for_a_subscription in EntitlementOverride.entitlement_overrides.entity_type has been added as request body parameter to upsert_or_remove_entitlement_overrides_for_a_subscription in EntitlementOverride.entitlement_overrides.is_enabled has been added as request body parameter to upsert_or_remove_entitlement_overrides_for_a_subscription in EntitlementOverride.payment_method_save_policy has been added as request body parameter to collect_now in HostedPage.decommissioned has been added as request body parameter to cancel_subscription_for_items in Subscription.pricing_page has been changed from required to optional in create_pricing_page_for_existing_subscription of PricingPageSession.payment_due_reminder has been added.charge has been added as a new value enum EntityType.payment_due_reminder has been added as a new value enum EventType.tempus has been added as a new value enum Gateway.kakao_pay, naver_pay, revolut_pay, and cash_app_pay have been added as new values enum PaymentMethod.always, ask, and never have been added as new values enum PaymentMethodSavePolicy.kakao_pay, naver_pay, revolut_pay, and cash_app_pay have been added as new values enum PaymentMethodType.kakao_pay, naver_pay, revolut_pay, and cash_app_pay have been added as new values enum Type.accepted, rejected, message_acknowledgement, in_process, under_query, conditionally_accepted, and paid have been added as new values to enum attribute einvoice.status in CreditNote.accepted, rejected, message_acknowledgement, in_process, under_query, conditionally_accepted, and paid have been added as new values to enum attribute status in Einvoice.accepted, rejected, message_acknowledgement, in_process, under_query, conditionally_accepted, and paid have been added as new values to enum attribute einvoice.status in Invoice.kakao_pay, naver_pay, revolut_pay, cash_app_pay, wechat_pay, and alipay have been added as new values to enum attribute payment_method_type in PaymentIntent.kakao_pay, naver_pay, revolut_pay, cash_app_pay, wechat_pay, and alipay have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.kakao_pay, naver_pay, revolut_pay, cash_app_pay, wechat_pay, and alipay have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.kakao_pay, naver_pay, revolut_pay, cash_app_pay, wechat_pay, and alipay have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.applicable_item_price_ids has been added to Coupon#CouponListRequest.
applicable_item_price_ids has been added to Coupon#CouponListRequest.applicable_item_price_ids has been added to Export#CouponRequest.Twikey has been added to GatewayEnum.move action has been removed from the ItemPrice.invoice_usages has been added to HostedPage#CheckoutExistingForItemsInputParam.
retry_engine has been added to Invoice#DunningAttempt.
QuotedDeltaRamp has been added.
reference_transactions has been added to Invoice.
Made a correct response schema for Entitlement#CreateResponse.
Fixed incorrect type for upcoming_renewal in OmnichannelSubscriptionItemResponse.
PersonalizedOffer has been added.
Use httpx instead of requests, thereby adding support for asynchronous API requests.
httpx instead of requests, thereby adding support for asynchronous API requests.* * *
Updated the ./chargebee/ssl/ca-certs.crt to use the latest version of DigiCert Global Root G2.
./chargebee/ssl/ca-certs.crt to use the latest version of DigiCert Global Root G2.WebhookEndpoints has been added.
Nothing published for this version
BillingConfiguration has been added.
* * *
* * *
* * *
* * *
* * *
* * *
* * *
* * *
Type fix for http_status_code in response.
http_status_code in response.ForwardRef in type annotations.error_cause_id has been added to API Error.Included http_status_code in GET requests.
deprecated label in discount_quantity has been removed from Coupon#CreateParams.
Releasing v3 version of Python SDK.
Releasing v3 version of Python SDK.
OmnichannelSubscriptionItem has been added.
Chargebee Client: Support for multiple clients has been introduced.
response_headers has been renamed to headers inside the response object.is_idempotency_replayed is now a direct attribute of the response object, no longer part of response_headers.Minimum Python Version: Python 3.11 or higher is now required.
int, float, bool, and enum data types.list entry to align with the API contract.is_idempotency_replayed is now a JSON entry inside response_headers instead of a method (is_idempotency_replayed()).wait_for_export_completion() and wait_for_time_travel_completion().Fixed an issue where empty parameters were incorrectly parsed as a JSON string for Content-Type: application/json requests. They are now correctly han
Content-Type: application/json requests. They are now correctly handled as an empty JSON object ({}) instead of an empty string.retry_engine has been added to Invoice#DunningAttempt.
QuotedDeltaRamp has been added.
reference_transactions has been added to Invoice.
PersonalizedOffer has been added.
Updated the ./chargebee/ssl/ca-certs.crt to use the latest version of DigiCert Global Root G2.
./chargebee/ssl/ca-certs.crt to use the latest version of DigiCert Global Root G2.WebhookEndpoints has been added.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
deprecated label in discount_quantity has been removed from Coupon#CreateParams.
discount_type has been added to CreditNote#Discount.
Updated the api_error class to make response headers an optional parameter, ensuring backward compatibility.
api_error class to make response headers an optional parameter, ensuring backward compatibility.Fixed issue preventing access to response headers during exceptions.
Your coding agent can read these notes before it upgrades. Set up the MCP server →