Release v3.28.0

CHANGELOG.md

@@ -1,3 +1,72 @@
+### v3.28.0 (2026-08-19)
+* * *
+### 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.
+- [`QuoteEntitlement`](https://apidocs.chargebee.com/docs/api/quote_entitlements) 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).
+- [`void_authorizations_before_capture`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture) has been added to [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- [`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:
+- [`payment_method_options`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#payment_method_options) has been added to [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+- [`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).
+- [`has_entitlements`](https://apidocs.chargebee.com/docs/api/quotes/quote-object#has_entitlements) has been added to [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+
+
+### New Parameters:
+- [`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).
+- [`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).
+- [`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).
+- [`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).
+- [`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).
+- [`locale`](https://apidocs.chargebee.com/docs/api/hosted_pages/create-a-pre-cancel-hosted-page#locale) has been added as request body parameter to [`create_a_pre-cancel_hosted_page`](https://apidocs.chargebee.com/docs/api/hosted_pages/create-a-pre-cancel-hosted-page) in [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).
+- [`comment`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture#comment) has been added as request body parameter to [`void_authorizations_before_capture`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- [`void_reason_code`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture#void_reason_code) has been added as request body parameter to [`void_authorizations_before_capture`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- [`invoice_action`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture#invoice_action) has been added as request body parameter to [`void_authorizations_before_capture`](https://apidocs.chargebee.com/docs/api/invoices/void-authorizations-before-capture) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- [`payment_method_options`](https://apidocs.chargebee.com/docs/api/payment_intents/update-a-payment-intent#payment_method_options) has been added as request body parameter to [`update_a_payment_intent`](https://apidocs.chargebee.com/docs/api/payment_intents/update-a-payment-intent) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+- [`payment_method_options`](https://apidocs.chargebee.com/docs/api/payment_intents/create-a-payment-intent#payment_method_options) has been added as request body parameter to [`create_a_payment_intent`](https://apidocs.chargebee.com/docs/api/payment_intents/create-a-payment-intent) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
+- [`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).
+- [`entitlement_overrides`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#entitlement_overrides) 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).
+- [`entitlement_overrides`](https://apidocs.chargebee.com/docs/api/quotes/edit-update-subscription-quote-for-items#entitlement_overrides) 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).
+- [`entitlement_overrides`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#entitlement_overrides) 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).
+- [`entitlement_overrides`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-update-subscription-items#entitlement_overrides) 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:
+- `consumption_based` has been added as a new value enum `CreditOptionForCurrentTermCharges`.
+- `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`.
+- `void` and `write_off` have been added as new values enum `InvoiceAction`.
+- `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).
+- `plan_price`, `addon_price`, `charge_price`, and `charge` have been added as new values to enum attribute [`entity_type`](https://apidocs.chargebee.com/docs/api/quote_entitlements/quote-entitlement-object#entity_type) in [`QuoteEntitlement`](https://apidocs.chargebee.com/docs/api/quote_entitlements).
+- `upsert` and `remove` have been added as new values to enum attribute [`action_type`](https://apidocs.chargebee.com/docs/api/quote_entitlements/quote-entitlement-object#action_type) in [`QuoteEntitlement`](https://apidocs.chargebee.com/docs/api/quote_entitlements).
+
+
+
 ### v3.27.0 (2026-07-30)
 * * *
 ### New Resources:

VERSION

@@ -1 +1 @@
-3.27.0
+3.28.0

chargebee/main.py

@@ -80,6 +80,7 @@ def __init__(
  self.Feature = chargebee.Feature(self.env)
  self.FilterCondition = chargebee.FilterCondition(self.env)
  self.GatewayErrorDetail = chargebee.GatewayErrorDetail(self.env)
+ self.GatewayPaymentMethodToken = chargebee.GatewayPaymentMethodToken(self.env)
  self.Gift = chargebee.Gift(self.env)
  self.GrantBlock = chargebee.GrantBlock(self.env)
  self.Hierarchy = chargebee.Hierarchy(self.env)
@@ -111,6 +112,9 @@ def __init__(
  self.OmnichannelSubscriptionItem = chargebee.OmnichannelSubscriptionItem(
  self.env
  )
+ self.OmnichannelSubscriptionItemMetric = (
+ chargebee.OmnichannelSubscriptionItemMetric(self.env)
+ )
  self.OmnichannelSubscriptionItemOffer = (
  chargebee.OmnichannelSubscriptionItemOffer(self.env)
  )
@@ -135,6 +139,7 @@ def __init__(
  self.PromotionalGrant = chargebee.PromotionalGrant(self.env)
  self.Purchase = chargebee.Purchase(self.env)
  self.Quote = chargebee.Quote(self.env)
+ self.QuoteEntitlement = chargebee.QuoteEntitlement(self.env)
  self.QuoteLineGroup = chargebee.QuoteLineGroup(self.env)
  self.QuotedCharge = chargebee.QuotedCharge(self.env)
  self.QuotedDeltaRamp = chargebee.QuotedDeltaRamp(self.env)
@@ -165,6 +170,7 @@ def __init__(
  self.UsageEvent = chargebee.UsageEvent(self.env)
  self.UsageFile = chargebee.UsageFile(self.env)
  self.UsageSummary = chargebee.UsageSummary(self.env)
+ self.VaultedPaymentMethod = chargebee.VaultedPaymentMethod(self.env)
  self.VirtualBankAccount = chargebee.VirtualBankAccount(self.env)
  self.WebhookEndpoint = chargebee.WebhookEndpoint(self.env)
 

chargebee/models/__init__.py

@@ -44,7 +44,9 @@
  FreePeriodUnit,
  FriendOfferType,
  Gateway,
+ GatewayName,
  HierarchyOperationType,
+ InvoiceAction,
  InvoiceDunningHandling,
  ItemType,
  Layout,
@@ -176,6 +178,10 @@
 
 from chargebee.models.gateway_error_detail.operations import GatewayErrorDetail
 
+from chargebee.models.gateway_payment_method_token.operations import (
+ GatewayPaymentMethodToken,
+)
+
 from chargebee.models.gift.operations import Gift
 
 from chargebee.models.grant_block.operations import GrantBlock
@@ -236,6 +242,10 @@
  OmnichannelSubscriptionItem,
 )
 
+from chargebee.models.omnichannel_subscription_item_metric.operations import (
+ OmnichannelSubscriptionItemMetric,
+)
+
 from chargebee.models.omnichannel_subscription_item_offer.operations import (
  OmnichannelSubscriptionItemOffer,
 )
@@ -282,6 +292,8 @@
 
 from chargebee.models.quote.operations import Quote
 
+from chargebee.models.quote_entitlement.operations import QuoteEntitlement
+
 from chargebee.models.quote_line_group.operations import QuoteLineGroup
 
 from chargebee.models.quoted_charge.operations import QuotedCharge
@@ -340,6 +352,8 @@
 
 from chargebee.models.usage_summary.operations import UsageSummary
 
+from chargebee.models.vaulted_payment_method.operations import VaultedPaymentMethod
+
 from chargebee.models.virtual_bank_account.operations import VirtualBankAccount
 
 from chargebee.models.webhook_endpoint.operations import WebhookEndpoint

chargebee/models/credit_note/operations.py

@@ -460,6 +460,9 @@ class CreditNotesForCustomerParams(TypedDict):
  class DeleteParams(TypedDict):
  comment: NotRequired[str]
 
+ class UpdateParams(TypedDict):
+ comment: NotRequired[str]
+
  class RemoveTaxWithheldRefundParams(TypedDict):
  tax_withheld: NotRequired["CreditNote.RemoveTaxWithheldRefundTaxWithheldParams"]
 
@@ -691,6 +694,26 @@ def delete(self, id, params: DeleteParams = None, headers=None) -> DeleteRespons
  operation="delete",
  )
 
+ def update(self, id, params: UpdateParams = None, headers=None) -> UpdateResponse:
+ jsonKeys = {}
+ options = {
+ "isIdempotent": True,
+ }
+ return request.send(
+ "post",
+ request.uri_path("credit_notes", id, "update"),
+ self.env,
+ cast(Dict[Any, Any], params),
+ headers,
+ UpdateResponse,
+ None,
+ False,
+ jsonKeys,
+ options,
+ resource="creditNote",
+ operation="update",
+ )
+
  def remove_tax_withheld_refund(
  self, id, params: RemoveTaxWithheldRefundParams, headers=None
  ) -> RemoveTaxWithheldRefundResponse:

chargebee/models/credit_note/responses.py

@@ -341,6 +341,12 @@ class DeleteResponse(Response):
  credit_note: CreditNoteResponse
 
 
+@dataclass
+class UpdateResponse(Response):
+ is_idempotency_replayed: bool
+ credit_note: CreditNoteResponse
+
+
 @dataclass
 class RemoveTaxWithheldRefundResponse(Response):
  is_idempotency_replayed: bool