Release v4.21.0

[cb-alish]

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.

[snyk-io]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[hivel-marco]

PR Complexity Score: 4.9 - Moderate

View Breakdown

• Lines Changed: 250
• Files Changed: 30
• Complexity Added: 0
• Raw Score: 95.0

Overview

This PR releases version 4.21.0 of the SDK, updating the changelog and version constants.
It introduces additional attributes and filters for Omnichannel subscriptions, expands Gift and Hosted Page APIs, and adds new payment method/event enums.
It also removes the deprecated QuoteEntitlement resource and the exclude query parameter on invoice listing, aligning the SDK with the latest API surface.

Key Changes

• Bumped SDK version from 4.20.1 to 4.21.0 and documented changes in the changelog as v4.21.0.
• Added purchased_at and updated_at attributes to OmnichannelSubscription, and updated_at to OmnichannelSubscriptionItem, improving tracking of subscription and item lifecycle updates.
• Extended list_omnichannel_subscriptions filters to support customer_id.in, customer_id.not_in, id, id_at_source, updated_at, and purchased_at for more flexible querying.
• Updated Gift API: updateGift now accepts an optional gift_receiver object (email, first_name, last_name), scheduled_at is optional, and the method’s $params argument is now optional in both interface and implementation.
• Extended Hosted Page checkout for gift subscriptions (checkout_gift_subscription_for_items) to accept an optional layout parameter.
• Removed the exclude query parameter from the invoice listing API in both interface and implementation, matching the documented API removal.
• Added new webhook/event support: omnichannel_subscription_item_updated and omnichannel_subscription_item_recovered to EnabledEvents and EventType.
• Added new payment methods (klarna, alipay_hk, paypay, gcash, south_korean_cards) to PaymentMethod, PaymentMethodType, Type, and Payment Intent–specific PaymentMethodType enums, and wired them into Payment Intent request/response enums.
• Removed QuoteEntitlement as a resource from Content, including its property, serialization/deserialization, and known field registration.
• Tidied various docblock array shapes (primarily reordering business_entity_id sub-keys) to reflect current API semantics without changing runtime behavior.

Risks & Considerations

• Removal of QuoteEntitlement from the SDK is a breaking change for any consumers that referenced Content::$quoteentitlement or quote_entitlement in responses; downstream code must be updated.
• Removal of the exclude filter from list_invoices may break integrations that currently pass this parameter; callers need to stop sending it.
• Making $params optional for updateGift and adding gift_receiver may expose edge cases if callers relied on strict parameter requirements or perform their own type validation.
• New enums for events and payment methods can affect consumers with exhaustive match/switch statements over event or payment method types.
• New Omnichannel filters and timestamp attributes should be validated in staging to ensure backend support and to confirm no unexpected null/format issues.
• None of the docblock-only reordering changes affect runtime behavior, but mismatches between docs and actual API expectations should still be spot-checked against API docs.

File-level change summary

File	Change summary
CHANGELOG.md	Added v4.21.0 release notes documenting new attributes, parameters, events, removed resources/parameters, and new enums.
VERSION	Bumped raw version file from 4.20.1 to 4.21.0.
src/Actions/Contracts/ExportActionsInterface.php	Reordered business_entity_id docblock keys to list is before is_present in multiple export methods.
src/Actions/Contracts/GiftActionsInterface.php	Added gift_receiver and optional scheduled_at to updateGift params and made $params optional in the interface.
src/Actions/Contracts/HostedPageActionsInterface.php	Added optional layout field to the checkout gift subscription for items request params docblock.
src/Actions/Contracts/InvoiceActionsInterface.php	Removed the exclude query parameter from the list invoices method docblock.
src/Actions/Contracts/ItemActionsInterface.php	Reordered business_entity_id docblock keys to list is before is_present for item listing.
src/Actions/Contracts/ItemFamilyActionsInterface.php	Reordered business_entity_id docblock keys to list is before is_present for item family listing.
src/Actions/Contracts/ItemPriceActionsInterface.php	Reordered business_entity_id docblock keys to list is before is_present for item price listing.
src/Actions/Contracts/OmnichannelSubscriptionActionsInterface.php	Expanded list-omnichannel-subscriptions params to include new filters on customer_id, id, id_at_source, updated_at, and purchased_at.
src/Actions/Contracts/PriceVariantActionsInterface.php	Reordered business_entity_id docblock keys to list is before is_present for price variant listing.
src/Actions/ExportActions.php	Mirrored export interface changes by reordering business_entity_id docblock keys in implementation methods.
src/Actions/GiftActions.php	Implemented updated updateGift signature with optional $params and added gift_receiver/optional scheduled_at in the docblock.
src/Actions/HostedPageActions.php	Implemented the new optional layout parameter in the checkout gift subscription for items hosted page method docblock.
src/Actions/InvoiceActions.php	Removed handling/documentation of the exclude query parameter from invoice listing implementation docblock.
src/Actions/ItemActions.php	Reordered business_entity_id docblock keys in the item actions implementation to match the interface.
src/Actions/ItemFamilyActions.php	Reordered business_entity_id docblock keys in item family actions implementation to match the interface.
src/Actions/ItemPriceActions.php	Reordered business_entity_id docblock keys in item price actions implementation to match the interface.
src/Actions/OmnichannelSubscriptionActions.php	Implemented new list-omnichannel-subscriptions filters (customer_id in/not_in, id, id_at_source, updated_at, purchased_at) in the docblock.
src/Actions/PriceVariantActions.php	Reordered business_entity_id docblock keys in price variant actions implementation to match the interface.
src/Enums/EnabledEvents.php	Added OMNICHANNEL_SUBSCRIPTION_ITEM_UPDATED and OMNICHANNEL_SUBSCRIPTION_ITEM_RECOVERED enum values.
src/Enums/EventType.php	Added OMNICHANNEL_SUBSCRIPTION_ITEM_UPDATED and OMNICHANNEL_SUBSCRIPTION_ITEM_RECOVERED event type values.
src/Enums/PaymentMethod.php	Added new payment method values for Klarna, Alipay HK, PayPay, GCash, and South Korean cards.
src/Enums/PaymentMethodType.php	Reordered PIX and added new payment method type values (Klarna, Alipay HK, PayPay, GCash, South Korean cards) to the SDK-level enum.
src/Enums/Type.php	Reordered PIX and added new generic Type enum values for Klarna, Alipay HK, PayPay, GCash, and South Korean cards.
src/Resources/Content/Content.php	Removed QuoteEntitlement usage and quote_entitlement handling from properties, known fields, constructor, from(), and toArray().
src/Resources/OmnichannelSubscription/OmnichannelSubscription.php	Added purchased_at and updated_at properties, wired them into known fields, constructor, from(), and toArray().
src/Resources/OmnichannelSubscriptionItem/OmnichannelSubscriptionItem.php	Added updated_at property, included it in known fields, constructor, from(), and toArray().
src/Resources/PaymentIntent/Enums/PaymentMethodType.php	Added Payment Intent–specific enum values for PIX, Klarna, Alipay HK, PayPay, GCash, and South Korean cards.
src/Version.php	Updated the SDK VERSION constant to 4.21.0.