chargebee/chargebee-php

v4.26.0 (2026-08-19)

New Resources:

• GatewayPaymentMethodToken has been added.
• OmnichannelSubscriptionItemMetric has been added.
• QuoteEntitlement has been added.
• VaultedPaymentMethod has been added.

New Actions:

• 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.

New Attributes:

• payment_method_options has been added to PaymentIntent.
• vault_token has been added to PaymentSource.
• has_entitlements has been added to Quote.

New Parameters:

• 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.

New Events:

• 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.

New Enums:

• 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.

v4.25.2 (2026-08-18)

Bug Fixes:

• HTTP methods are now uppercased before a request is constructed, so the SDK no longer emits deprecation notices from guzzlehttp/psr7 2.11+ (Passing a non-uppercase HTTP method is deprecated) or guzzlehttp/guzzle 7.11+. Both libraries preserve method casing in their next major versions, where a lowercase method would have been sent on the wire as-is.

v4.25.1 (2026-08-11)

Bug Fixes:

• Filter operators in, not_in and between are now sent as a single form field by URLFormEncoder, at any nesting depth. Filters on export operations, such as ramp[effective_from][between], were index-encoded and therefore ignored by the API.

v4.25.0 (2026-07-30)

New Resources:

• CreditUnit has been added.
• LedgerEntry has been added.

New Actions:

• allocate has been added to LedgerOperation.

New Attributes:

• 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.

New Parameters:

• 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.

New Events:

• grant_blocks_created has been added.
• ledger_updated has been added.
• ledger_account_balance_updated has been added.
• grant_blocks_updated has been added.

New Enums:

• 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.

Release v4.25.0 adds CreditUnit and LedgerEntry resources, credit unit actions, ledger operation allocation, expanded ledger response data, new resource fields and request filters, four webhook events, and numerous enum values. Documentation and version metadata are updated accordingly.

v4.24.0 (2026-07-21)

New Resources:

• AsyncResponse has been added.
• AsyncResponseList has been added.
• ColumnDefinition has been added.
• Meter has been added.
• MeteredFeature has been added.

New Attributes:

• 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.

New Parameters:

• 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.

Parameter Updates:

• metered_feature_id has been changed from required to optional in create_an_alert of Alert.

New Events:

• payment_source_business_entity_changed has been added.

Deleted Attributes:

• start_balance has been removed from LedgerOperation.
• end_balance has been removed from LedgerOperation.

New Enums:

• 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.

v4.23.0 (2026-06-30)

New Features

• Added an optional telemetry adapter hook for tracing Chargebee API calls via OpenTelemetry (or any APM). Configure it via the telemetryAdapter client option (or Environment::setTelemetryAdapter). When unconfigured, the SDK skips all telemetry work — no behavior change for existing integrations.
• Each API call emits one CLIENT span (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.
• Exposed the TelemetryAdapter, RequestTelemetryContext, RequestTelemetryResult, RequestTelemetryError types, the TelemetrySupport helpers, and the TelemetryAttributeKeys constants under the Chargebee\Telemetry namespace.

v4.22.0 (2026-06-12)

New Resources:

• GrantBlock has been added.
• LedgerAccountBalance has been added.
• LedgerOperation has been added.
• PromotionalGrant has been added.

New Attributes:

• notes has been added to CreditNote.
• layout has been added to HostedPage.

New Parameters:

• sort_by has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.

New Enums:

• 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.

v4.21.0 (2026-06-08)

New Attributes:

• purchased_at has been added to OmnichannelSubscription.
• updated_at has been added to OmnichannelSubscription.
• updated_at has been added to OmnichannelSubscriptionItem.

New Parameters:

• 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.

Parameter Updates:

• scheduled_at has been changed from required to optional in update_a_gift of Gift.

New Events:

• omnichannel_subscription_item_updated has been added.
• omnichannel_subscription_item_recovered has been added.

Deleted Resources:

• QuoteEntitlement has been removed.

Deleted Attributes:

• 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.

Deleted Parameters:

• exclude has been removed as query parameter from list_invoices in Invoice.

New Enums:

• 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.

4.20.1 (2026-06-01)

Fixed

• Corrected Usage Summary API documentation URLs to use /usage_summary/ instead of /usage_summaries/.

v4.20.0 (2026-05-04)

New Resources:

• QuoteEntitlement has been added.

New Actions:

• 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.

New Attributes:

• alarm_status has been added to AlertStatus.

New Parameters:

• 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.

Deleted Attributes:

• alarm_triggered_at has been removed from Alert.
• scope has been removed from Alert.
• alert_status has been removed from AlertStatus.

New Enums:

• 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.

• Releasing major version v4.0.0 :tada:

• Renamed directory to comply with the autoloader standard.

• Added a way to append suffix in User-Agent headers through Chargebee::Environment.
• Fixed double parsing issue when input is already in JSON format for JSON attributes.

• chargebee-php now requires PHP >= 8.1.
• The namespace ChargeBee has been renamed to Chargebee.
• Models now follow the namespace use Chargebee\Resources\*; instead of use ChargeBee\ChargeBee\Models\*;
• The way to initialize the Chargebee client has changed.
• Users no longer need to import individual classes for operations.
• The response will no longer return a global Result class; instead, it returns a specific response class for each action.
• Input parameters have changed from camelCase to snake_case.

Bug Fixes

• Fixed double parsing issue when input is already in JSON format for JSON keys.

New Resources:

• Rule has been added.
• UsageEvent has been added.

New Attribute:

• deleted has been added to AttachedItem.
• deleted has been added to Coupon.
• deleted has been added to DifferentialPrice.
• deleted has been added to ItemFamily.
• deleted has been added to ItemPrice.
• deleted has been added to Item.
• deleted has been added to PriceVariant.
• tax_application has abeend added to CreditNote#Allocation.
• tax_application has been added to Invoice#AppliedCredit.
• line_item_credit has been added to Invoice.

New Input Params:

• exhausted_coupon_ids has been added to Subscription#ImportForItems.

New Enums

• STORE has been added in CreditNote#TypeEnum.
• STORE has been added in CreditNoteEstimate#TypeEnum.
• STORE has been added in Order#TypeEnum.
• TaxApplicationEnum has been added in CreditNote#Application.
• TaxApplicationEnum has been added in Invoice#AppliedCredit.
• RECORDED_PURCHASE has been added in EntityTypeEnum.
• RECORD_PURCHASE_FAILED, has been added in EventTypeEnum.

Deleted Input Params

• tax_providers_fields has been removed from Customer#MoveParams.
• tax_providers_fields has been removed from Customer#MergeParams

Deprecated input params.

• deprecated label in discount_quantity has been removed from Coupon#CreateParams.
• deprecated label in discount_quantity has been removed from Coupon#UpdateParams.
• deprecated label in discount_quantity has been removed from Coupon#CreateForItemsParams.
• deprecated label in discount_quantity has been removed from Coupon#UpdateForItemsParams.

New Resource:

• Configuration has been added.

New Attribute:

• discount_type has been added to CreditNote#Discount.
• discount_type has been added to CreditNoteEstimate#Discount.
• discount_type has been added to Invoice#Discount.
• discount_type has been added to InvoiceEstimate#Discount.
• discount_type has been added to QuoteLineGroup#Discount.
• initial_purchase_transaction has been added to OmnichannelSubscription.
• error_cause_id has been added to GatewayErrorDetail.
• error_cause_id has been added to Transaction#GatewayErrorDetail.
• error_cause_id has been added to APIError.
• deleted has been added to Quote.
• current_term_start has been added to QuotedSubscripiton#SubscriptionItem.
• current_term_end has been added to QuotedSubscripiton#SubscriptionItem.
• next_billing_at has been added to QuotedSubscripiton#SubscriptionItem.
• current_term_start has been added to Subscription#SubscriptionItem.
• current_term_end has been added to Subscription#SubscriptionItem.
• next_billing_at has been added to Subscription#SubscriptionItem.
• billing_override has been added to Subscription.
• grace_period_expires_at has been added to OmnichannelSubscriptionItem.

New Input Params:

• billing_override has been added to Subscription#CreateWithItemsInputParam.
• billing_override has been added to Subscription#UpdateForItemsInputParam.

New Enum Values:

• OMNICHANNEL_SUBSCRIPTION_IMPORTED has been added to EventTypeEnum.
• DISABLED has been added to Event#WebhookStatus.
• OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_STARTED has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_EXPIRED has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_STARTED has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_EXPIRED has been added to EventTypeEnum.
• IGNORED has been added to RecordedPurchase#StatusEnum.
• IN_DUNNING & IN_GRACE_PERIOD have been added to OmnichannelSubscriptionItem#StatusEnum.

Bug Fixes:

• empty array being converted to null object bug fixed.

New Resource:

• OmnichannelSubscriptionItem has been added.

New Attribute:

• resource_version has been added to OmnichannelSubscription.
• resource_version has been added to OmnichannelTransaction.
• resource_version has been added to RecordedPurchase.

New Input Parameters:

• limit has been added to OmnichannelSubscription#ListRequest.
• offset has been added to OmnichannelSubscription#ListRequest.
• customer_id has been added to OmnichannelSubscription#ListRequest.
• replace_coupon_list has been added to HostedPage#CheckoutExistingRequest.
• replace_coupon_list has been added to HostedPage#CheckoutExistingForItemsRequest.
• subscription[po_number] has been added to HostedPage#CheckoutNewForItemsRequest.

Removed Subresource:

• OmnichannelSubscriptionItem subresource has been removed from OmnichannelSubscription and is now a standalone resource.

Deprecated Attribute:

• metadata has been deprecated from subscription.

New Resource:

• OmnichannelTransaction has been added.
• OmnichannelSubscription has been added.
• RecordedPurchase has been added.

New Attributes:

• business_entity_id has been added to AttachedItem.
• business_entity_id has been added to DifferentialPrice.
• business_entity_id has been added to Items.
• business_entity_id has been added to ItemFamily.
• business_entity_id has been added to ItemPrice.
• business_entity_id has been added to PriceVariant.
• valid_from has been added to coupon.

New Input Parameters:

• business_entity_id has been added to AttachedItem#CreateRequest.
• preferred_scheme has been added to Card#UpdateCardForCustomerRequest.
• valid_from has been added to Coupon#CreateForItem & Coupon#UpdateForItemsRequest.
• preferred_scheme has been added to Customer#CreateRequest & Customer#CollectPaymentRequest.
• business_entity_id has been added to DifferentialPrice#CreateRequest.
• preferred_scheme has been added to Invoice#CreateRequest & Invoice#CreateForChargeItemsAndChargesRequest.
• business_entity_id has been added to Items#CreateRequest.
• business_entity_id & include_site_level_resources have been added to Items#ListItemParams.
• business_entity_id has been added to ItemFamily#CreateRequest.
• business_entity_id & include_site_level_resources have been added to ItemFamily#ListItemFamilyParams.
• business_entity_id has been added to ItemPrice#CreateRequest.
• business_entity_id & include_site_level_resources have been added to ItemPrice#ListItemPriceParams.
• business_entity_id & include_site_level_resources have been added to PriceVariant#ListItemFamilyParams.
• business_entity_id has been added to PriceVariant#CreateRequest.
• business_entity_id & include_site_level_resources have been added to PriceVariant#ListPriceVariantParams.
• preferred_scheme has been added to Subscription#CreateRequest, Subscription#UpdateRequest.
• preferred_scheme Subscription#UpdateForItemsRequest, & Subscription#ImportSubscriptionRequest.
• business_entity_id & include_site_level_resources have been added to Export#ItemFamiliesRequest & Export#ItemsRequest.
• business_entity_id & include_site_level_resources have been added to Export#ItemPricesRequest Export#PriceVariantsRequest
• name & flexible_schedules[period] have been added to PaymentScheduleScheme#CreateRequest.

New Enum Values:

• FUTURE has been added to Coupon#StatusEnum.
• EXISTING_CUSTOMER & NEW_CUSTOMER have been added to Coupon#TypeEnum.
• LATE_FAILURE has added to Transation#LinkedPaymentEnum & Transation#StatusEnum.
• OMNICHANNEL_SUBSCRIPTION, has been added to EntityTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM, has been added to EntityTypeEnum.
• OMNICHANNEL_TRANSACTION, has been added to EntityTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_RENEWED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_CREATED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADE_SCHEDULED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_DOWNGRADE_REMOVED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_EXPIRED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_CANCELLATION_SCHEDULED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CANCELLATION_REMOVED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_RESUBSCRIBED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_UPGRADED, has been added to EventTypeEnum.
• OMNICHANNEL_SUBSCRIPTION_ITEM_CANCELLED, has been added to EventTypeEnum.

Deprecated method name:

• PaymentVoucherPaymentVouchersForInvoiceRequest method payment_vouchersForInvoice use paymentVouchersForInvoice instead.
• PaymentVoucherPaymentVouchersForCustomerRequest method payment_vouchersForCustomer use paymentVouchersForCustomer instead.

New Resource:

• PaymentScheduleEstimate has been added.

Bug Fixes:

• metadata field not working bug fixed.
• meta_data field not working bug fixed.