Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,63 @@
### v4.21.0 (2026-06-08)
* * *
### New Attributes:
- [`purchased_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/omnichannel-subscription-object#purchased_at) has been added to [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
- [`updated_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/omnichannel-subscription-object#updated_at) has been added to [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
- [`updated_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_items/omnichannel-subscription-item-object#updated_at) has been added to [`OmnichannelSubscriptionItem`](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_items).


### New Parameters:
- [`customer_id.in`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#customer_id_in) 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).
- [`customer_id.not_in`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#customer_id_not_in) 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).
- [`id`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#id) 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).
- [`id_at_source`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#id_at_source) 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).
- [`updated_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#updated_at) 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).
- [`purchased_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#purchased_at) 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).
- [`gift_receiver`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift#gift_receiver) has been added as request body parameter to [`update_a_gift`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift) in [`Gift`](https://apidocs.chargebee.com/docs/api/gifts).
- [`layout`](https://apidocs.chargebee.com/docs/api/hosted_pages/checkout-gift-subscription-for-items#layout) has been added as request body parameter to [`checkout_gift_subscription_for_items`](https://apidocs.chargebee.com/docs/api/hosted_pages/checkout-gift-subscription-for-items) in [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).


### Parameter Updates:
- [`scheduled_at`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift#scheduled_at) has been changed from required to optional in [`update_a_gift`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift) of [`Gift`](https://apidocs.chargebee.com/docs/api/gifts).


### New Events:
- [`omnichannel_subscription_item_updated`](https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_updated) has been added.
- [`omnichannel_subscription_item_recovered`](https://apidocs.chargebee.com/docs/api/events/webhook/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`](https://apidocs.chargebee.com/docs/api/invoices/list-invoices) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).


### 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`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#payment_method_type) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` 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).
- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/update-a-payment-intent) of [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/create-a-payment-intent) of [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).



## 4.20.1 (2026-06-01)

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.20.1
4.21.0
8 changes: 4 additions & 4 deletions src/Actions/Contracts/ExportActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -395,8 +395,8 @@ public function differentialPrices(array $params = [], array $headers = []): Dif
* },
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down Expand Up @@ -602,8 +602,8 @@ public function retrieve(string $id, array $headers = []): RetrieveExportRespons
* },
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down Expand Up @@ -693,8 +693,8 @@ public function priceVariants(array $params = [], array $headers = []): PriceVar
* },
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down Expand Up @@ -1862,8 +1862,8 @@ public function orders(array $params = [], array $headers = []): OrdersExportRes
* not_in?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
9 changes: 7 additions & 2 deletions src/Actions/Contracts/GiftActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,12 @@ public function cancel(string $id, array $headers = []): CancelGiftResponse;
/**
* @see https://apidocs.chargebee.com/docs/api/gifts/update-a-gift?lang=php-v4
* @param array{
* scheduled_at?: int,
* gift_receiver?: array{
* email?: string,
* first_name?: string,
* last_name?: string,
* },
* scheduled_at?: int,
* comment?: string,
* } $params Description of the parameters
* @param string $id
Expand All @@ -120,7 +125,7 @@ public function cancel(string $id, array $headers = []): CancelGiftResponse;
* @throws InvalidRequestException
* @throws Exception
*/
public function updateGift(string $id, array $params, array $headers = []): UpdateGiftGiftResponse;
public function updateGift(string $id, array $params = [], array $headers = []): UpdateGiftGiftResponse;

/**
* @see https://apidocs.chargebee.com/docs/api/gifts/list-gifts?lang=php-v4
Expand Down
1 change: 1 addition & 0 deletions src/Actions/Contracts/HostedPageActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ public function events(array $params, array $headers = []): EventsHostedPageResp
* ending_unit_in_decimal?: string,
* price_in_decimal?: string,
* }>,
* layout?: string,
* business_entity_id?: string,
* redirect_url?: string,
* coupon_ids?: array<string>,
Expand Down
3 changes: 0 additions & 3 deletions src/Actions/Contracts/InvoiceActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -452,9 +452,6 @@ public function pauseDunning(string $id, array $params, array $headers = []): Pa
* asc?: string,
* desc?: string,
* },
* exclude?: array{
* in?: mixed,
* },
* } $params Description of the parameters
*
* @param array<string, string> $headers
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/Contracts/ItemActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@
* not_in?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/Contracts/ItemFamilyActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ public function delete(string $id, array $headers = []): DeleteItemFamilyRespons
* between?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/Contracts/ItemPriceActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@ public function findApplicableItems(string $id, array $params = [], array $heade
* between?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
24 changes: 24 additions & 0 deletions src/Actions/Contracts/OmnichannelSubscriptionActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,30 @@ public function omnichannelTransactionsForOmnichannelSubscription(string $id, ar
* is?: mixed,
* is_not?: mixed,
* starts_with?: mixed,
* in?: mixed,
* not_in?: mixed,
* },
* id?: array{
* is?: mixed,
* is_not?: mixed,
* starts_with?: mixed,
* in?: mixed,
* not_in?: mixed,
* },
* id_at_source?: array{
* is?: mixed,
* is_not?: mixed,
* starts_with?: mixed,
* in?: mixed,
* not_in?: mixed,
* },
* updated_at?: array{
* before?: mixed,
* after?: mixed,
* },
* purchased_at?: array{
* before?: mixed,
* after?: mixed,
* },
* } $params Description of the parameters
*
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/Contracts/PriceVariantActionsInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ public function delete(string $id, array $headers = []): DeletePriceVariantRespo
* between?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
8 changes: 4 additions & 4 deletions src/Actions/ExportActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -479,8 +479,8 @@ public function differentialPrices(array $params = [], array $headers = []): Dif
* },
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down Expand Up @@ -738,8 +738,8 @@ public function retrieve(string $id, array $headers = []): RetrieveExportRespons
* },
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down Expand Up @@ -847,8 +847,8 @@ public function priceVariants(array $params = [], array $headers = []): PriceVar
* },
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down Expand Up @@ -2124,8 +2124,8 @@ public function orders(array $params = [], array $headers = []): OrdersExportRes
* not_in?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
9 changes: 7 additions & 2 deletions src/Actions/GiftActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,12 @@ public function cancel(string $id, array $headers = []): CancelGiftResponse
/**
* @see https://apidocs.chargebee.com/docs/api/gifts/update-a-gift?lang=php-v4
* @param array{
* scheduled_at?: int,
* gift_receiver?: array{
* email?: string,
* first_name?: string,
* last_name?: string,
* },
* scheduled_at?: int,
* comment?: string,
* } $params Description of the parameters
* @param string $id
Expand All @@ -170,7 +175,7 @@ public function cancel(string $id, array $headers = []): CancelGiftResponse
* @throws InvalidRequestException
* @throws Exception
*/
public function updateGift(string $id, array $params, array $headers = []): UpdateGiftGiftResponse
public function updateGift(string $id, array $params = [], array $headers = []): UpdateGiftGiftResponse
{
$jsonKeys = [
];
Expand Down
1 change: 1 addition & 0 deletions src/Actions/HostedPageActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ public function events(array $params, array $headers = []): EventsHostedPageResp
* ending_unit_in_decimal?: string,
* price_in_decimal?: string,
* }>,
* layout?: string,
* business_entity_id?: string,
* redirect_url?: string,
* coupon_ids?: array<string>,
Expand Down
3 changes: 0 additions & 3 deletions src/Actions/InvoiceActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -696,9 +696,6 @@ public function pauseDunning(string $id, array $params, array $headers = []): Pa
* asc?: string,
* desc?: string,
* },
* exclude?: array{
* in?: mixed,
* },
* } $params Description of the parameters
*
* @param array<string, string> $headers
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/ItemActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
* not_in?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/ItemFamilyActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ public function delete(string $id, array $headers = []): DeleteItemFamilyRespons
* between?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/ItemPriceActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -347,8 +347,8 @@ public function findApplicableItems(string $id, array $params = [], array $heade
* between?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
24 changes: 24 additions & 0 deletions src/Actions/OmnichannelSubscriptionActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,30 @@ public function omnichannelTransactionsForOmnichannelSubscription(string $id, ar
* is?: mixed,
* is_not?: mixed,
* starts_with?: mixed,
* in?: mixed,
* not_in?: mixed,
* },
* id?: array{
* is?: mixed,
* is_not?: mixed,
* starts_with?: mixed,
* in?: mixed,
* not_in?: mixed,
* },
* id_at_source?: array{
* is?: mixed,
* is_not?: mixed,
* starts_with?: mixed,
* in?: mixed,
* not_in?: mixed,
* },
* updated_at?: array{
* before?: mixed,
* after?: mixed,
* },
* purchased_at?: array{
* before?: mixed,
* after?: mixed,
* },
* } $params Description of the parameters
*
Expand Down
2 changes: 1 addition & 1 deletion src/Actions/PriceVariantActions.php
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ public function delete(string $id, array $headers = []): DeletePriceVariantRespo
* between?: mixed,
* },
* business_entity_id?: array{
* is_present?: mixed,
* is?: mixed,
* is_present?: mixed,
* },
* include_site_level_resources?: array{
* is?: mixed,
Expand Down
2 changes: 2 additions & 0 deletions src/Enums/EnabledEvents.php
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ enum EnabledEvents : string {
case OMNICHANNEL_SUBSCRIPTION_MOVED_IN = "omnichannel_subscription_moved_in";
case OMNICHANNEL_TRANSACTION_CREATED = "omnichannel_transaction_created";
case ALERT_STATUS_CHANGED = "alert_status_changed";
case OMNICHANNEL_SUBSCRIPTION_ITEM_UPDATED = "omnichannel_subscription_item_updated";
case OMNICHANNEL_SUBSCRIPTION_ITEM_RECOVERED = "omnichannel_subscription_item_recovered";
case PLAN_CREATED = "plan_created";
case PLAN_UPDATED = "plan_updated";
case PLAN_DELETED = "plan_deleted";
Expand Down
2 changes: 2 additions & 0 deletions src/Enums/EventType.php
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@ enum EventType : string {
case OMNICHANNEL_SUBSCRIPTION_MOVED_IN = "omnichannel_subscription_moved_in";
case OMNICHANNEL_TRANSACTION_CREATED = "omnichannel_transaction_created";
case ALERT_STATUS_CHANGED = "alert_status_changed";
case OMNICHANNEL_SUBSCRIPTION_ITEM_UPDATED = "omnichannel_subscription_item_updated";
case OMNICHANNEL_SUBSCRIPTION_ITEM_RECOVERED = "omnichannel_subscription_item_recovered";
case PLAN_CREATED = "plan_created";
case PLAN_UPDATED = "plan_updated";
case PLAN_DELETED = "plan_deleted";
Expand Down
Loading
Loading