Release v4.16.0

CHANGELOG.md

@@ -1,3 +1,46 @@
+### v4.16.0 (2026-02-06)
+* * *
+### New Attributes:
+- [`subscription_id`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/entitlement-override-object#subscription_id) has been added to [`EntitlementOverride`](https://apidocs.chargebee.com/docs/api/entitlement_overrides).
+- [`is_enabled`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/entitlement-override-object#is_enabled) has been added to [`EntitlementOverride`](https://apidocs.chargebee.com/docs/api/entitlement_overrides).
+- [`decommissioned`](https://apidocs.chargebee.com/docs/api/subscriptions/subscription-object#decommissioned) has been added to [`Subscription`](https://apidocs.chargebee.com/docs/api/subscriptions).
+
+
+### New Parameters:
+- [`omnichannel_subscription_item`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#omnichannel_subscription_item) has been added as query parameter to [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) in [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
+- [`entitlement_overrides.entity_id`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription#entitlement_overrides_entity_id) has been added as request body parameter to [`upsert_or_remove_entitlement_overrides_for_a_subscription`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription) in [`EntitlementOverride`](https://apidocs.chargebee.com/docs/api/entitlement_overrides).
+- [`entitlement_overrides.entity_type`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription#entitlement_overrides_entity_type) has been added as request body parameter to [`upsert_or_remove_entitlement_overrides_for_a_subscription`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription) in [`EntitlementOverride`](https://apidocs.chargebee.com/docs/api/entitlement_overrides).
+- [`entitlement_overrides.is_enabled`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription#entitlement_overrides_is_enabled) has been added as request body parameter to [`upsert_or_remove_entitlement_overrides_for_a_subscription`](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription) in [`EntitlementOverride`](https://apidocs.chargebee.com/docs/api/entitlement_overrides).
+- [`payment_method_save_policy`](https://apidocs.chargebee.com/docs/api/hosted_pages/collect-now#payment_method_save_policy) has been added as request body parameter to [`collect_now`](https://apidocs.chargebee.com/docs/api/hosted_pages/collect-now) in [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).
+- [`decommissioned`](https://apidocs.chargebee.com/docs/api/subscriptions/cancel-subscription-for-items#decommissioned) has been added as request body parameter to [`cancel_subscription_for_items`](https://apidocs.chargebee.com/docs/api/subscriptions/cancel-subscription-for-items) in [`Subscription`](https://apidocs.chargebee.com/docs/api/subscriptions).
+
+
+### Parameter Updates:
+- [`pricing_page`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription#pricing_page) has been changed from required to optional in [`create_pricing_page_for_existing_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription) of [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+
+
+### New Events:
+- [`payment_due_reminder`](https://apidocs.chargebee.com/docs/api/events/webhook/payment_due_reminder) has been added.
+
+
+### New Enums:
+- `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`](https://apidocs.chargebee.com/docs/api/credit_notes/credit-note-object#einvoice_status) in [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
+- `accepted`, `rejected`, `message_acknowledgement`, `in_process`, `under_query`, `conditionally_accepted`, and `paid` have been added as new values to enum attribute [`status`](https://apidocs.chargebee.com/docs/api/einvoices/einvoice-object#status) in [`Einvoice`](https://apidocs.chargebee.com/docs/api/einvoices).
+- `accepted`, `rejected`, `message_acknowledgement`, `in_process`, `under_query`, `conditionally_accepted`, and `paid` have been added as new values to enum attribute [`einvoice.status`](https://apidocs.chargebee.com/docs/api/invoices/invoice-object#einvoice_status) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#payment_method_type) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#active_payment_attempt_payment_method_type) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/update-a-payment-intent) of [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/create-a-payment-intent) of [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+
+
+
 ### v4.15.1 (2026-01-19)
 * * * 
 

VERSION

@@ -1 +1 @@
-4.15.1
+4.16.0

src/Actions/AddonActions.php

@@ -31,7 +31,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#copy_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/copy-an-addon?lang=php-v4
     *   @param array{
     *     from_site?: string,
     *     id_at_from_site?: string,
@@ -68,7 +68,7 @@ public function copy(array $params, array $headers = []): CopyAddonResponse
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#unarchive_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/unarchive-an-addon?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -99,7 +99,7 @@ public function unarchive(string $id, array $headers = []): UnarchiveAddonRespon
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#retrieve_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/retrieve-an-addon?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -129,7 +129,7 @@ public function retrieve(string $id, array $headers = []): RetrieveAddonResponse
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#update_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/update-an-addon?lang=php-v4
     *   @param array{
     *     tiers?: array<array{
     *     starting_unit?: int,
@@ -212,7 +212,7 @@ public function update(string $id, array $params, array $headers = []): UpdateAd
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#list_addons
+    *   @see https://apidocs.chargebee.com/docs/api/addons/list-addons?lang=php-v4
     *   @param array{
     *     limit?: int,
     *     offset?: string,
@@ -328,7 +328,7 @@ public function all(array $params = [], array $headers = []): ListAddonResponse
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#create_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/create-an-addon?lang=php-v4
     *   @param array{
     *     tiers?: array<array{
     *     starting_unit?: int,
@@ -413,7 +413,7 @@ public function create(array $params, array $headers = []): CreateAddonResponse
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#delete_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/delete-an-addon?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers

src/Actions/AddressActions.php

@@ -25,7 +25,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addresses?lang=php#retrieve_an_address
+    *   @see https://apidocs.chargebee.com/docs/api/addresses/retrieve-an-address?lang=php-v4
     *   @param array{
     *     subscription_id?: string,
     *     label?: string,
@@ -59,7 +59,7 @@ public function retrieve(array $params, array $headers = []): RetrieveAddressRes
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addresses?lang=php#update_an_address
+    *   @see https://apidocs.chargebee.com/docs/api/addresses/update-an-address?lang=php-v4
     *   @param array{
     *     subscription_id?: string,
     *     label?: string,

src/Actions/AttachedItemActions.php

@@ -29,7 +29,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/attached_items?lang=php#retrieve_an_attached_item_
+    *   @see https://apidocs.chargebee.com/docs/api/attached_items/retrieve-an-attached-item-?lang=php-v4
     *   @param array{
     *     parent_item_id?: string,
     *     } $params Description of the parameters
@@ -62,7 +62,7 @@ public function retrieve(string $id, array $params, array $headers = []): Retrie
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/attached_items?lang=php#update_an_attached_item
+    *   @see https://apidocs.chargebee.com/docs/api/attached_items/update-an-attached-item?lang=php-v4
     *   @param array{
     *     parent_item_id?: string,
     *     type?: string,
@@ -102,7 +102,7 @@ public function update(string $id, array $params, array $headers = []): UpdateAt
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/attached_items?lang=php#list_attached_items
+    *   @see https://apidocs.chargebee.com/docs/api/attached_items/list-attached-items?lang=php-v4
     *   @param array{
     *     limit?: int,
     *     offset?: string,
@@ -174,7 +174,7 @@ public function all(string $id, array $params = [], array $headers = []): ListAt
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/attached_items?lang=php#create_an_attached_item
+    *   @see https://apidocs.chargebee.com/docs/api/attached_items/create-an-attached-item?lang=php-v4
     *   @param array{
     *     item_id?: string,
     *     type?: string,
@@ -215,7 +215,7 @@ public function create(string $id, array $params, array $headers = []): CreateAt
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/attached_items?lang=php#delete_an_attached_item
+    *   @see https://apidocs.chargebee.com/docs/api/attached_items/delete-an-attached-item?lang=php-v4
     *   @param array{
     *     parent_item_id?: string,
     *     } $params Description of the parameters

src/Actions/BusinessEntityActions.php

@@ -26,7 +26,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/business_entities?lang=php#list_the_business_entity_transfers
+    *   @see https://apidocs.chargebee.com/docs/api/business_entities/list-the-business-entity-transfers?lang=php-v4
     *   @param array{
     *     limit?: int,
     *     offset?: string,
@@ -79,7 +79,7 @@ public function getTransfers(array $params = [], array $headers = []): GetTransf
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/business_entities?lang=php#transfer_resources_to_another_business_entity
+    *   @see https://apidocs.chargebee.com/docs/api/business_entities/transfer-resources-to-another-business-entity?lang=php-v4
     *   @param array{
     *     active_resource_ids?: array<string>,
     * destination_business_entity_ids?: array<string>,

src/Actions/CardActions.php

@@ -28,7 +28,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/cards?lang=php#copy_card
+    *   @see https://apidocs.chargebee.com/docs/api/cards/copy-card?lang=php-v4
     *   @param array{
     *     gateway_account_id?: string,
     *     } $params Description of the parameters
@@ -62,7 +62,7 @@ public function copyCardForCustomer(string $id, array $params, array $headers =
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/cards?lang=php#retrieve_card_for_a_customer
+    *   @see https://apidocs.chargebee.com/docs/api/cards/retrieve-card-for-a-customer?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -92,7 +92,7 @@ public function retrieve(string $id, array $headers = []): RetrieveCardResponse
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/cards?lang=php#switch_gateway
+    *   @see https://apidocs.chargebee.com/docs/api/cards/switch-gateway?lang=php-v4
     *   @param array{
     *     gateway?: string,
     *     gateway_account_id?: string,
@@ -127,7 +127,7 @@ public function switchGatewayForCustomer(string $id, array $params, array $heade
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/cards?lang=php#delete_card_for_a_customer
+    *   @see https://apidocs.chargebee.com/docs/api/cards/delete-card-for-a-customer?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -158,7 +158,7 @@ public function deleteCardForCustomer(string $id, array $headers = []): DeleteCa
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/cards?lang=php#update_card_for_a_customer
+    *   @see https://apidocs.chargebee.com/docs/api/cards/update-card-for-a-customer?lang=php-v4
     *   @param array{
     *     customer?: array{
     *     vat_number?: string,

src/Actions/CommentActions.php

@@ -28,7 +28,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/comments?lang=php#delete_a_comment
+    *   @see https://apidocs.chargebee.com/docs/api/comments/delete-a-comment?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -59,7 +59,7 @@ public function delete(string $id, array $headers = []): DeleteCommentResponse
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/comments?lang=php#retrieve_a_comment
+    *   @see https://apidocs.chargebee.com/docs/api/comments/retrieve-a-comment?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -89,7 +89,7 @@ public function retrieve(string $id, array $headers = []): RetrieveCommentRespon
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/comments?lang=php#list_comments
+    *   @see https://apidocs.chargebee.com/docs/api/comments/list-comments?lang=php-v4
     *   @param array{
     *     limit?: int,
     *     offset?: string,
@@ -135,7 +135,7 @@ public function all(array $params = [], array $headers = []): ListCommentRespons
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/comments?lang=php#create_a_comment
+    *   @see https://apidocs.chargebee.com/docs/api/comments/create-a-comment?lang=php-v4
     *   @param array{
     *     entity_type?: string,
     *     entity_id?: string,

src/Actions/ConfigurationActions.php

@@ -24,7 +24,7 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     }
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/configurations?lang=php#list_site_configurations
+    *   @see https://apidocs.chargebee.com/docs/api/configurations/list-site-configurations?lang=php-v4
     *   
     *   
     *   @param array<string, string> $headers

src/Actions/Contracts/AddonActionsInterface.php

@@ -18,7 +18,7 @@
 {
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#copy_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/copy-an-addon?lang=php-v4
     *   @param array{
     *     from_site?: string,
     *     id_at_from_site?: string,
@@ -37,7 +37,7 @@
     public function copy(array $params, array $headers = []): CopyAddonResponse;
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#unarchive_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/unarchive-an-addon?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -51,7 +51,7 @@ public function copy(array $params, array $headers = []): CopyAddonResponse;
     public function unarchive(string $id, array $headers = []): UnarchiveAddonResponse;
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#retrieve_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/retrieve-an-addon?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers
@@ -65,7 +65,7 @@ public function unarchive(string $id, array $headers = []): UnarchiveAddonRespon
     public function retrieve(string $id, array $headers = []): RetrieveAddonResponse;
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#update_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/update-an-addon?lang=php-v4
     *   @param array{
     *     tiers?: array<array{
     *     starting_unit?: int,
@@ -129,7 +129,7 @@ public function retrieve(string $id, array $headers = []): RetrieveAddonResponse
     public function update(string $id, array $params, array $headers = []): UpdateAddonResponse;
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#list_addons
+    *   @see https://apidocs.chargebee.com/docs/api/addons/list-addons?lang=php-v4
     *   @param array{
     *     limit?: int,
     *     offset?: string,
@@ -228,7 +228,7 @@ public function update(string $id, array $params, array $headers = []): UpdateAd
     public function all(array $params = [], array $headers = []): ListAddonResponse;
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#create_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/create-an-addon?lang=php-v4
     *   @param array{
     *     tiers?: array<array{
     *     starting_unit?: int,
@@ -294,7 +294,7 @@ public function all(array $params = [], array $headers = []): ListAddonResponse;
     public function create(array $params, array $headers = []): CreateAddonResponse;
 
     /**
-    *   @see https://apidocs.chargebee.com/docs/api/addons?lang=php#delete_an_addon
+    *   @see https://apidocs.chargebee.com/docs/api/addons/delete-an-addon?lang=php-v4
     *   
     *   @param string $id  
     *   @param array<string, string> $headers