Release v4.26.0

CHANGELOG.md

@@ -1,3 +1,54 @@
+### v4.26.0 (2026-08-12)
+* * *
+### New Resources:
+- [`GatewayPaymentMethodToken`](https://apidocs.chargebee.com/docs/api/gateway_payment_method_tokens) has been added.
+- [`OmnichannelSubscriptionItemMetric`](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_item_metrics) has been added.
+- [`VaultedPaymentMethod`](https://apidocs.chargebee.com/docs/api/vaulted_payment_methods) has been added.
+
+
+### New Actions:
+- [`update_credit_note_details`](https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details) has been added to [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
+- [`export_subscription_ramps`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps) has been added to [`Export`](https://apidocs.chargebee.com/docs/api/exports).
+- [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) has been added to [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
+
+
+### New Attributes:
+- [`vault_token`](https://apidocs.chargebee.com/docs/api/payment_sources/payment-source-object#vault_token) has been added to [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
+
+
+### New Parameters:
+- [`updated_at.between`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#updated_at_between) 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.on`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#updated_at_on) 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.between`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#purchased_at_between) 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.on`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#purchased_at_on) 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).
+- [`limit`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source#limit) has been added as query parameter to [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) in [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
+- [`offset`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source#offset) has been added as query parameter to [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) in [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
+- [`include_deleted`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source#include_deleted) has been added as query parameter to [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) in [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
+- [`comment`](https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details#comment) has been added as request body parameter to [`update_credit_note_details`](https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details) in [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
+- [`ramp`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps#ramp) has been added as request body parameter to [`export_subscription_ramps`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps) in [`Export`](https://apidocs.chargebee.com/docs/api/exports).
+- [`export_type`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps#export_type) has been added as request body parameter to [`export_subscription_ramps`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps) in [`Export`](https://apidocs.chargebee.com/docs/api/exports).
+- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_items_description) has been added as request body parameter to [`create_a_quote_for_a_new_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/edit-update-subscription-quote-for-items#subscription_items_description) has been added as request body parameter to [`edit_update_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-update-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#subscription_items_description) has been added as request body parameter to [`edit_create_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-update-subscription-items#subscription_items_description) has been added as request body parameter to [`create_a_quote_for_update_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-update-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+
+
+### New Events:
+- [`vault_token_updated`](https://apidocs.chargebee.com/docs/api/events/webhook/vault_token_updated) has been added.
+- [`vault_token_deleted`](https://apidocs.chargebee.com/docs/api/events/webhook/vault_token_deleted) has been added.
+- [`omnichannel_subscription_item_mrr_updated`](https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_mrr_updated) has been added.
+- [`vault_token_created`](https://apidocs.chargebee.com/docs/api/events/webhook/vault_token_created) has been added.
+
+
+### New Enums:
+- `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`.
+- `active`, `inactive`, and `pending_verification` have been added as new values to enum attribute [`status`](https://apidocs.chargebee.com/docs/api/gateway_payment_method_tokens/gateway-payment-method-token-object#status) in [`GatewayPaymentMethodToken`](https://apidocs.chargebee.com/docs/api/gateway_payment_method_tokens).
+- `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`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#payment_intent_metadata_source) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+
+
+
 ### v4.25.1 (2026-08-11)
 * * *
 ### Bug Fixes: 

VERSION

@@ -1 +1 @@
-4.25.1
+4.26.0

src/Actions/Contracts/CouponActionsInterface.php

@@ -86,8 +86,8 @@
     *     not_in?: mixed,
     *     },
     * applicable_item_price_ids?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * } $params Description of the parameters
     *   

src/Actions/Contracts/CreditNoteActionsInterface.php

@@ -8,6 +8,7 @@
 use Chargebee\Responses\CreditNoteResponse\VoidCreditNoteCreditNoteResponse;
 use Chargebee\Responses\CreditNoteResponse\CreateCreditNoteResponse;
 use Chargebee\Responses\CreditNoteResponse\DownloadEinvoiceCreditNoteResponse;
+use Chargebee\Responses\CreditNoteResponse\UpdateCreditNoteResponse;
 use Chargebee\Responses\CreditNoteResponse\RemoveTaxWithheldRefundCreditNoteResponse;
 use Chargebee\Responses\CreditNoteResponse\CreditNotesForCustomerCreditNoteResponse;
 use Chargebee\Responses\CreditNoteResponse\RetrieveCreditNoteResponse;
@@ -447,6 +448,22 @@ public function all(array $params = [], array $headers = []): ListCreditNoteResp
     */
     public function create(array $params, array $headers = []): CreateCreditNoteResponse;
 
+    /**
+    *   @see https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details?lang=php-v4
+    *   @param array{
+    *     comment?: string,
+    *     } $params Description of the parameters
+    *   @param string $id  
+    *   @param array<string, string> $headers
+    *   @return UpdateCreditNoteResponse
+    *   @throws PaymentException
+    *   @throws OperationFailedException
+    *   @throws APIError
+    *   @throws InvalidRequestException
+    *   @throws Exception
+    */
+    public function update(string $id, array $params = [], array $headers = []): UpdateCreditNoteResponse;
+
     /**
     *   @see https://apidocs.chargebee.com/docs/api/credit_notes/download-e-invoice-for-credit-note?lang=php-v4
     *   

src/Actions/Contracts/CreditUnitActionsInterface.php

@@ -21,12 +21,12 @@
     *     limit?: int,
     *     offset?: string,
     *     status?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * id?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * } $params Description of the parameters
     *   

src/Actions/Contracts/EntitlementActionsInterface.php

@@ -18,16 +18,16 @@
     *     limit?: int,
     *     offset?: string,
     *     feature_id?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * entity_type?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * entity_id?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * include_drafts?: bool,
     *     embed?: string,

src/Actions/Contracts/ExportActionsInterface.php

@@ -9,6 +9,7 @@
 use Chargebee\Responses\ExportResponse\CreditNotesExportResponse;
 use Chargebee\Responses\ExportResponse\CouponsExportResponse;
 use Chargebee\Responses\ExportResponse\SubscriptionsExportResponse;
+use Chargebee\Responses\ExportResponse\RampsExportResponse;
 use Chargebee\Responses\ExportResponse\OrdersExportResponse;
 use Chargebee\Responses\ExportResponse\PlansExportResponse;
 use Chargebee\Responses\ExportResponse\AttachedItemsExportResponse;
@@ -326,6 +327,44 @@ public function attachedItems(array $params = [], array $headers = []): Attached
     */
     public function transactions(array $params = [], array $headers = []): TransactionsExportResponse;
 
+    /**
+    *   @see https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps?lang=php-v4
+    *   @param array{
+    *     ramp?: array{
+    *     status?: array{
+    *         is?: string,
+    *             in?: string,
+    *             },
+    *     subscription_id?: array{
+    *         is?: string,
+    *             in?: string,
+    *             },
+    *     effective_from?: array{
+    *         after?: string,
+    *             before?: string,
+    *             on?: string,
+    *             between?: string,
+    *             },
+    *     updated_at?: array{
+    *         after?: string,
+    *             before?: string,
+    *             on?: string,
+    *             between?: string,
+    *             },
+    *     },
+    * export_type?: string,
+    *     } $params Description of the parameters
+    *   
+    *   @param array<string, string> $headers
+    *   @return RampsExportResponse
+    *   @throws PaymentException
+    *   @throws OperationFailedException
+    *   @throws APIError
+    *   @throws InvalidRequestException
+    *   @throws Exception
+    */
+    public function ramps(array $params = [], array $headers = []): RampsExportResponse;
+
     /**
     *   @see https://apidocs.chargebee.com/docs/api/exports/export-differential-price?lang=php-v4
     *   @param array{
@@ -1602,8 +1641,8 @@ public function creditNotes(array $params = [], array $headers = []): CreditNote
     *     not_in?: mixed,
     *     },
     * applicable_item_price_ids?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * } $params Description of the parameters
     *   

src/Actions/Contracts/InvoiceActionsInterface.php

@@ -1244,13 +1244,13 @@ public function removeTaxWithheld(string $id, array $params, array $headers = []
     *     offset?: string,
     *     payment_reference_number?: array{
     *     number?: array{
-    *         in?: string,
-    *             is?: string,
+    *         is?: string,
+    *             in?: string,
     *             },
     *     },
     * id?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * } $params Description of the parameters
     *   

src/Actions/Contracts/LedgerOperationActionsInterface.php

@@ -117,8 +117,8 @@ public function authorize(array $params, array $headers = []): AuthorizeLedgerOp
     *     between?: mixed,
     *     },
     * type?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * sort_by?: array{
     *     asc?: string,

src/Actions/Contracts/OmnichannelSubscriptionActionsInterface.php

@@ -107,12 +107,16 @@ public function omnichannelTransactionsForOmnichannelSubscription(string $id, ar
     *     not_in?: mixed,
     *     },
     * updated_at?: array{
-    *     before?: mixed,
     *     after?: mixed,
+    *     before?: mixed,
+    *     between?: mixed,
+    *     on?: mixed,
     *     },
     * purchased_at?: array{
-    *     before?: mixed,
     *     after?: mixed,
+    *     before?: mixed,
+    *     between?: mixed,
+    *     on?: mixed,
     *     },
     * sort_by?: array{
     *     asc?: string,

src/Actions/Contracts/PaymentSourceActionsInterface.php

@@ -1,6 +1,7 @@
 <?php
 namespace Chargebee\Actions\Contracts;
 
+use Chargebee\Responses\PaymentSourceResponse\ListGatewayTokensForPaymentSourcePaymentSourceResponse;
 use Chargebee\Responses\PaymentSourceResponse\DeletePaymentSourceResponse;
 use Chargebee\Responses\PaymentSourceResponse\RetrievePaymentSourceResponse;
 use Chargebee\Responses\PaymentSourceResponse\UpdateBankAccountPaymentSourceResponse;
@@ -123,6 +124,24 @@ public function delete(string $id, array $headers = []): DeletePaymentSourceResp
     */
     public function createCard(array $params, array $headers = []): CreateCardPaymentSourceResponse;
 
+    /**
+    *   @see https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source?lang=php-v4
+    *   @param array{
+    *     limit?: int,
+    *     offset?: string,
+    *     include_deleted?: bool,
+    *     } $params Description of the parameters
+    *   @param string $id  
+    *   @param array<string, string> $headers
+    *   @return ListGatewayTokensForPaymentSourcePaymentSourceResponse
+    *   @throws PaymentException
+    *   @throws OperationFailedException
+    *   @throws APIError
+    *   @throws InvalidRequestException
+    *   @throws Exception
+    */
+    public function listGatewayTokensForPaymentSource(string $id, array $params = [], array $headers = []): ListGatewayTokensForPaymentSourcePaymentSourceResponse;
+
     /**
     *   @see https://apidocs.chargebee.com/docs/api/payment_sources/verify-bank-account-payment-source?lang=php-v4
     *   @param array{

src/Actions/Contracts/QuoteActionsInterface.php

@@ -101,6 +101,7 @@
     *     charge_on_option?: string,
     *     start_date?: int,
     *     end_date?: int,
+    *     description?: string,
     *     ramp_tier_id?: string,
     *     }>,
     *     discounts?: array<array{
@@ -319,6 +320,7 @@ public function retrieveSignedPdf(string $id, array $headers = []): RetrieveSign
     *     item_type?: string,
     *     start_date?: int,
     *     end_date?: int,
+    *     description?: string,
     *     ramp_tier_id?: string,
     *     }>,
     *     discounts?: array<array{
@@ -563,6 +565,7 @@ public function delete(string $id, array $params = [], array $headers = []): Del
     *     charge_on_option?: string,
     *     start_date?: int,
     *     end_date?: int,
+    *     description?: string,
     *     ramp_tier_id?: string,
     *     }>,
     *     discounts?: array<array{
@@ -685,6 +688,7 @@ public function editCreateSubCustomerQuoteForItems(string $id, array $params, ar
     *     item_type?: string,
     *     start_date?: int,
     *     end_date?: int,
+    *     description?: string,
     *     ramp_tier_id?: string,
     *     }>,
     *     discounts?: array<array{

src/Actions/Contracts/RampActionsInterface.php

@@ -111,12 +111,12 @@ public function createForSubscription(string $id, array $params, array $headers
     *     offset?: string,
     *     include_deleted?: bool,
     *     status?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * subscription_id?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * effective_from?: array{
     *     after?: mixed,

src/Actions/Contracts/VaultedPaymentMethodActionsInterface.php

@@ -0,0 +1,29 @@
+<?php
+namespace Chargebee\Actions\Contracts;
+
+use Chargebee\Responses\VaultedPaymentMethodResponse\RetrieveVaultedPaymentMethodResponse;
+use Exception;
+use Chargebee\Exceptions\PaymentException;
+use Chargebee\Exceptions\OperationFailedException;
+use Chargebee\Exceptions\APIError;
+use Chargebee\Exceptions\InvalidRequestException;
+
+Interface VaultedPaymentMethodActionsInterface
+{
+
+    /**
+    *   @see https://apidocs.chargebee.com/docs/api/vaulted_payment_methods/retrieve-vaulted-payment-method?lang=php-v4
+    *   
+    *   @param string $id  
+    *   @param array<string, string> $headers
+    *   @return RetrieveVaultedPaymentMethodResponse
+    *   @throws PaymentException
+    *   @throws OperationFailedException
+    *   @throws APIError
+    *   @throws InvalidRequestException
+    *   @throws Exception
+    */
+    public function retrieve(string $id, array $headers = []): RetrieveVaultedPaymentMethodResponse;
+
+}
+?>

src/Actions/CouponActions.php

@@ -99,8 +99,8 @@ public function __construct(HttpClientFactory $httpClientFactory, Environment $e
     *     not_in?: mixed,
     *     },
     * applicable_item_price_ids?: array{
-    *     in?: mixed,
     *     is?: mixed,
+    *     in?: mixed,
     *     },
     * } $params Description of the parameters
     *