Releases: chargebee/chargebee-php
Releases · chargebee/chargebee-php
v4.22.0
v4.22.0 (2026-06-12)
New Resources:
GrantBlockhas been added.LedgerAccountBalancehas been added.LedgerOperationhas been added.PromotionalGranthas been added.
New Attributes:
noteshas been added toCreditNote.layouthas been added toHostedPage.
New Parameters:
sort_byhas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.
New Enums:
available,exhausted,scheduled, andin_grace_periodhave been added as new values enumStatus.subscription_created,subscription_changed,top_up,promotional_grants, androlloverhave been added as new values to enum attributegrant_sourceinGrantBlock.provisionedandoverdrafthave been added as new values to enum attributeaccount_typeinGrantBlock.credit_unithas been added as a new value to enum attributeunit_typeinGrantBlock.credit_unithas been added as a new value to enum attributeunit_typeinLedgerAccountBalance.allocation,capture,authorize,release_authorization,capture_authorization,expiry,void,rollover, andadjustmenthave been added as new values to enum attributetypeinLedgerOperation.credit_unithas been added as a new value to enum attributeunit_typeinLedgerOperation.expires_at,created_at, andeffective_fromhave been added as new values to enum query parametersort_by.ascinlist_grant_blocksofGrantBlock.expires_at,created_at, andeffective_fromhave been added as new values to enum query parametersort_by.descinlist_grant_blocksofGrantBlock.allocation,release_authorization,void,capture,rollover,adjustment,expiry,authorize, andcapture_authorizationhave been added as new values to enum query parametertype.isinlist_ledger_operationsofLedgerOperation.allocation,release_authorization,void,capture,rollover,adjustment,expiry,authorize, andcapture_authorizationhave been added as new values to enum query parametertype.ininlist_ledger_operationsofLedgerOperation.created_athas been added as a new value to enum query parametersort_by.ascinlist_ledger_operationsofLedgerOperation.created_athas been added as a new value to enum query parametersort_by.descinlist_ledger_operationsofLedgerOperation.updated_atandcreated_athave been added as new values to enum query parametersort_by.ascinlist_omnichannel_subscriptionsofOmnichannelSubscription.updated_atandcreated_athave been added as new values to enum query parametersort_by.descinlist_omnichannel_subscriptionsofOmnichannelSubscription.
v4.21.0
v4.21.0 (2026-06-08)
New Attributes:
purchased_athas been added toOmnichannelSubscription.updated_athas been added toOmnichannelSubscription.updated_athas been added toOmnichannelSubscriptionItem.
New Parameters:
customer_id.inhas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.customer_id.not_inhas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.idhas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.id_at_sourcehas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.updated_athas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.purchased_athas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.gift_receiverhas been added as request body parameter toupdate_a_giftinGift.layouthas been added as request body parameter tocheckout_gift_subscription_for_itemsinHostedPage.
Parameter Updates:
scheduled_athas been changed from required to optional inupdate_a_giftofGift.
New Events:
omnichannel_subscription_item_updatedhas been added.omnichannel_subscription_item_recoveredhas been added.
Deleted Resources:
- QuoteEntitlement has been removed.
Deleted Attributes:
entity_idhas been removed fromQuoteEntitlement.entity_typehas been removed fromQuoteEntitlement.feature_idhas been removed fromQuoteEntitlement.valuehas been removed fromQuoteEntitlement.is_enabledhas been removed fromQuoteEntitlement.start_datehas been removed fromQuoteEntitlement.end_datehas been removed fromQuoteEntitlement.created_athas been removed fromQuoteEntitlement.modified_athas been removed fromQuoteEntitlement.
Deleted Parameters:
excludehas been removed as query parameter fromlist_invoicesinInvoice.
New Enums:
omnichannel_subscription_item_updatedandomnichannel_subscription_item_recoveredhave been added as new values enumEventType.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values enumPaymentMethod.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values enumPaymentMethodType.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values enumType.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values to enum attributepayment_method_typeinPaymentIntent.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values to enum attributeactive_payment_attempt.payment_method_typeinPaymentIntent.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values to enum request body parameterpayment_method_typeinupdate_a_payment_intentofPaymentIntent.klarna,alipay_hk,paypay,gcash, andsouth_korean_cardshave been added as new values to enum request body parameterpayment_method_typeincreate_a_payment_intentofPaymentIntent.
v4.20.1
v4.20.0
v4.20.0 (2026-05-04)
New Resources:
QuoteEntitlementhas been added.
New Actions:
list_applicable_alerts_for_a_subscriptionhas been added toAlert.retrieve_an_alerthas been added toAlert.update_an_alerthas been added toAlert.delete_an_alerthas been added toAlert.list_alertshas been added toAlert.create_an_alerthas been added toAlert.list_alert_statuses_for_a_subscriptionhas been added toAlertStatus.list_alert_statuses_for_an_alerthas been added toAlertStatus.
New Attributes:
alarm_statushas been added toAlertStatus.
New Parameters:
limithas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.offsethas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.statushas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.typehas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.limithas been added as query parameter tolist_alertsinAlert.offsethas been added as query parameter tolist_alertsinAlert.idhas been added as query parameter tolist_alertsinAlert.typehas been added as query parameter tolist_alertsinAlert.subscription_idhas been added as query parameter tolist_alertsinAlert.statushas been added as query parameter tolist_alertsinAlert.limithas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.offsethas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.alarm_statushas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.alert_idhas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.limithas been added as query parameter tolist_alert_statuses_for_an_alertinAlertStatus.offsethas been added as query parameter tolist_alert_statuses_for_an_alertinAlertStatus.alarm_statushas been added as query parameter tolist_alert_statuses_for_an_alertinAlertStatus.excludehas been added as query parameter tolist_invoicesinInvoice.thresholdhas been added as request body parameter toupdate_an_alertinAlert.statushas been added as request body parameter toupdate_an_alertinAlert.thresholdhas been added as request body parameter tocreate_an_alertinAlert.filter_conditionshas been added as request body parameter tocreate_an_alertinAlert.typehas been added as request body parameter tocreate_an_alertinAlert.namehas been added as request body parameter tocreate_an_alertinAlert.descriptionhas been added as request body parameter tocreate_an_alertinAlert.metered_feature_idhas been added as request body parameter tocreate_an_alertinAlert.subscription_idhas been added as request body parameter to [create_an_alert](https://apidocs.chargebee.com/docs/a...
v4.19.0
v4.19.0 (2026-03-27)
New Resources:
Alerthas been added.AlertStatushas been added.CpqQuoteSignaturehas been added.
New Actions:
update_a_quote_signature_statushas been added toQuote.update_a_quote_signaturehas been added toQuote.retrieve_a_quote_signature_signed_pdfhas been added toQuote.retrieve_a_quote_signaturehas been added toQuote.create_a_quote_signaturehas been added toQuote.refresh_a_quote_signature_linkhas been added toQuote.
New Attributes:
reference_idhas been added toEinvoice.provider_referenceshas been added toEinvoice.created_athas been added toUnbilledCharge.
New Parameters:
include_usage_chargeshas been added as query parameter toupcoming_invoices_estimateinEstimate.business_entity_idhas been added as request body parameter tomanage_payment_sourcesinHostedPage.cpq_quote_signaturehas been added as request body parameter toupdate_a_quote_signature_statusinQuote.gateway_account_idhas been added as request body parameter tocreate_a_virtual_bank_accountinVirtualBankAccount.gateway_account_idhas been added as request body parameter tocreate_a_virtual_bank_account_using_permanent_tokeninVirtualBankAccount.
New Events:
alert_status_changedhas been added.
New Enums:
alert_statushas been added as a new value enumEntityType.alert_status_changedhas been added as a new value enumEventType.pixhas been added as a new value enumPaymentMethod.pixhas been added as a new value enumPaymentMethodType.pixandusage_exceededhave been added as new values enumType.enabledanddisabledhave been added as new values to enum attributestatusinAlert.globalandsubscriptionhave been added as new values to enum attributescopeinAlert.draft,active,signed,expired,cancelled, anddeclinedhave been added as new values to enum attributestatusinCpqQuoteSignature.esign_and_pay,esign, andpayhave been added as new values to enum attributecustomer_acceptance_methodinCpqQuoteSignature.consolidatedanddetailedhave been added as new values to enum attributequote_typeinCpqQuoteSignature.pixhas been added as a new value to enum attributepayment_method_typeinPaymentIntent.pixhas been added as a new value to enum attributeactive_payment_attempt.payment_method_typeinPaymentIntent.pixhas been added as a new value to enum request body parameterpayment_method_typeinupdate_a_payment_intentofPaymentIntent.pixhas been added as a new value to enum request body parameterpayment_method_typeincreate_a_payment_intentofPaymentIntent.expired,declined,draft,active,signed, andcancelledhave been added as new values to enum request body parametercpq_quote_signature.statusinupdate_a_quote_signature_statusofQuote.
v4.18.0
v4.18.0 (2025-03-03)
PSR-18 / PSR-17 HTTP client injection (backward compatible):
- Direct PSR-18 injection: You can now inject a
Psr\Http\Client\ClientInterface(PSR-18) directly intoChargebeeClientwithout implementing the Chargebee-specificHttpClientFactoryinterface. - Optional PSR-17 factories: When using a PSR-18 client, you may optionally pass
RequestFactoryInterfaceandStreamFactoryInterface(PSR-17). When omitted, php-http/discovery auto-discovers any installed PSR-17 implementation. - New adapter:
Chargebee\HttpClient\PsrClientAdapterwraps a PSR-18 client and builds PSR-7 requests using the injected or discovered PSR-17 request/stream factories. - Backward compatibility: The existing
HttpClientFactoryinjection path and the defaultGuzzleFactoryare unchanged.
New dependencies (require):
php-http/discovery^1.0psr/http-factory^1.0
v4.17.0
v4.17.0 (2026-03-02)
New Resources:
UsageChargehas been added.UsageSummaryhas been added.
New Attributes:
free_periodhas been added toQuotedSubscription.free_period_unithas been added toQuotedSubscription.
New Parameters:
net_term_dayshas been added as request body parameter tocreate_invoice_for_items_and_one-time_chargesinInvoice.contract_termhas been added as request body parameter tocreate_pricing_page_for_existing_subscriptioninPricingPageSession.contract_termhas been added as request body parameter tocreate_pricing_page_for_new_subscriptioninPricingPageSession.subscription.free_periodhas been added as request body parameter tocreate_a_quote_for_a_new_subscription_itemsinQuote.subscription.free_period_unithas been added as request body parameter tocreate_a_quote_for_a_new_subscription_itemsinQuote.subscription.free_periodhas been added as request body parameter toedit_create_subscription_quote_for_itemsinQuote.subscription.free_period_unithas been added as request body parameter toedit_create_subscription_quote_for_itemsinQuote.
New Enums:
month,week,day,hour, andminutehave been added as new values enumWindowSize.cancel,renew_once,renew, andevergreenhave been added as new values to enum request body parametercontract_term.action_at_term_endincreate_pricing_page_for_existing_subscriptionofPricingPageSession.cancel,renew_once,renew, andevergreenhave been added as new values to enum request body parametercontract_term.action_at_term_endincreate_pricing_page_for_new_subscriptionofPricingPageSession.
v4.16.0
v4.16.0 (2026-02-06)
New Attributes:
subscription_idhas been added toEntitlementOverride.is_enabledhas been added toEntitlementOverride.decommissionedhas been added toSubscription.
New Parameters:
omnichannel_subscription_itemhas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.entitlement_overrides.entity_idhas been added as request body parameter toupsert_or_remove_entitlement_overrides_for_a_subscriptioninEntitlementOverride.entitlement_overrides.entity_typehas been added as request body parameter toupsert_or_remove_entitlement_overrides_for_a_subscriptioninEntitlementOverride.entitlement_overrides.is_enabledhas been added as request body parameter toupsert_or_remove_entitlement_overrides_for_a_subscriptioninEntitlementOverride.payment_method_save_policyhas been added as request body parameter tocollect_nowinHostedPage.decommissionedhas been added as request body parameter tocancel_subscription_for_itemsinSubscription.
Parameter Updates:
pricing_pagehas been changed from required to optional increate_pricing_page_for_existing_subscriptionofPricingPageSession.
New Events:
payment_due_reminderhas been added.
New Enums:
chargehas been added as a new value enumEntityType.payment_due_reminderhas been added as a new value enumEventType.tempushas been added as a new value enumGateway.kakao_pay,naver_pay,revolut_pay, andcash_app_payhave been added as new values enumPaymentMethod.always,ask, andneverhave been added as new values enumPaymentMethodSavePolicy.kakao_pay,naver_pay,revolut_pay, andcash_app_payhave been added as new values enumPaymentMethodType.kakao_pay,naver_pay,revolut_pay, andcash_app_payhave been added as new values enumType.accepted,rejected,message_acknowledgement,in_process,under_query,conditionally_accepted, andpaidhave been added as new values to enum attributeeinvoice.statusinCreditNote.accepted,rejected,message_acknowledgement,in_process,under_query,conditionally_accepted, andpaidhave been added as new values to enum attributestatusinEinvoice.accepted,rejected,message_acknowledgement,in_process,under_query,conditionally_accepted, andpaidhave been added as new values to enum attributeeinvoice.statusinInvoice.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum attributepayment_method_typeinPaymentIntent.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum attributeactive_payment_attempt.payment_method_typeinPaymentIntent.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum request body parameterpayment_method_typeinupdate_a_payment_intentofPaymentIntent.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum request body parameterpayment_method_typeincreate_a_payment_intentofPaymentIntent.
v4.15.1
v4.15.0
v4.15.0 (2026-01-16)
New Parameters:
applicable_item_price_idshas been added to Coupon#CouponListRequest.applicable_item_price_idshas been added to Export#CouponRequest.
New Enums:
Twikeyhas been added to GatewayEnum.
Deleted Action:
moveaction has been removed from the ItemPrice.