Release v3.31.0

CHANGELOG.md

@@ -1,3 +1,72 @@
+### v3.31.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.30.1 (2026-08-11)
 * * *
 ### Bug Fixes: 

VERSION

@@ -1 +1 @@
-3.30.1
+3.31.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.30.1",
+  "version": "3.31.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm ci && npm run build",

src/environment.ts

@@ -9,7 +9,7 @@ export const Environment = {
   hostSuffix: '.chargebee.com',
   apiPath: '/api/v2',
   timeout: DEFAULT_TIME_OUT,
-  clientVersion: 'v3.30.1',
+  clientVersion: 'v3.31.0',
   port: DEFAULT_PORT,
   timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
   exportWaitInMillis: DEFAULT_EXPORT_WAIT,

src/resources/api_endpoints.ts

@@ -25,7 +25,9 @@ interface Endpoints {
   businessEntityTransfer: EndpointTuple[];
   token: EndpointTuple[];
   paymentSource: EndpointTuple[];
+  gatewayPaymentMethodToken: EndpointTuple[];
   thirdPartyPaymentMethod: EndpointTuple[];
+  vaultedPaymentMethod: EndpointTuple[];
   virtualBankAccount: EndpointTuple[];
   card: EndpointTuple[];
   promotionalCredit: EndpointTuple[];
@@ -48,6 +50,7 @@ interface Endpoints {
   quotedDeltaRamp: EndpointTuple[];
   billingConfiguration: EndpointTuple[];
   quoteLineGroup: EndpointTuple[];
+  quoteEntitlement: EndpointTuple[];
   cpqQuoteSignature: EndpointTuple[];
   plan: EndpointTuple[];
   addon: EndpointTuple[];
@@ -95,6 +98,7 @@ interface Endpoints {
   paymentScheduleScheme: EndpointTuple[];
   pricingPageSession: EndpointTuple[];
   omnichannelSubscriptionItemScheduledChange: EndpointTuple[];
+  omnichannelSubscriptionItemMetric: EndpointTuple[];
   omnichannelSubscription: EndpointTuple[];
   omnichannelTransaction: EndpointTuple[];
   omnichannelSubscriptionItem: EndpointTuple[];
@@ -1071,6 +1075,17 @@ export const Endpoints: Endpoints = {
         isIdempotent: true,
       },
     ],
+    [
+      'listGatewayTokensForPaymentSource',
+      'GET',
+      '/payment_sources',
+      '/gateway_payment_method_tokens',
+      true,
+      null,
+      false,
+      {},
+      {},
+    ],
     ['retrieve', 'GET', '/payment_sources', null, true, null, false, {}, {}],
     ['list', 'GET', '/payment_sources', null, false, null, false, {}, {}],
     [
@@ -1126,7 +1141,21 @@ export const Endpoints: Endpoints = {
       },
     ],
   ],
+  gatewayPaymentMethodToken: [],
   thirdPartyPaymentMethod: [],
+  vaultedPaymentMethod: [
+    [
+      'retrieve',
+      'GET',
+      '/vaulted_payment_methods',
+      null,
+      true,
+      null,
+      false,
+      {},
+      {},
+    ],
+  ],
   virtualBankAccount: [
     [
       'createUsingPermanentToken',
@@ -1718,6 +1747,19 @@ export const Endpoints: Endpoints = {
         isIdempotent: true,
       },
     ],
+    [
+      'voidBeforeCapture',
+      'POST',
+      '/invoices',
+      '/void_before_capture',
+      true,
+      null,
+      false,
+      {},
+      {
+        isIdempotent: true,
+      },
+    ],
     [
       'delete',
       'POST',
@@ -1902,6 +1944,19 @@ export const Endpoints: Endpoints = {
         isIdempotent: true,
       },
     ],
+    [
+      'update',
+      'POST',
+      '/credit_notes',
+      '/update',
+      true,
+      null,
+      false,
+      {},
+      {
+        isIdempotent: true,
+      },
+    ],
     [
       'removeTaxWithheldRefund',
       'POST',
@@ -3158,6 +3213,19 @@ export const Endpoints: Endpoints = {
   quotedDeltaRamp: [],
   billingConfiguration: [],
   quoteLineGroup: [],
+  quoteEntitlement: [
+    [
+      'listQuoteEntitlements',
+      'GET',
+      '/quotes',
+      '/quote_entitlements',
+      true,
+      null,
+      false,
+      {},
+      {},
+    ],
+  ],
   cpqQuoteSignature: [],
   plan: [
     [
@@ -3933,6 +4001,19 @@ export const Endpoints: Endpoints = {
         isIdempotent: true,
       },
     ],
+    [
+      'ramps',
+      'POST',
+      '/exports',
+      '/ramps',
+      false,
+      null,
+      false,
+      {},
+      {
+        isIdempotent: true,
+      },
+    ],
   ],
   paymentIntent: [
     [
@@ -3943,7 +4024,9 @@ export const Endpoints: Endpoints = {
       false,
       null,
       false,
-      {},
+      {
+        payment_method_options: 0,
+      },
       {
         isIdempotent: true,
       },
@@ -3956,7 +4039,9 @@ export const Endpoints: Endpoints = {
       true,
       null,
       false,
-      {},
+      {
+        payment_method_options: 0,
+      },
       {
         isIdempotent: true,
       },
@@ -4877,6 +4962,7 @@ export const Endpoints: Endpoints = {
     ],
   ],
   omnichannelSubscriptionItemScheduledChange: [],
+  omnichannelSubscriptionItemMetric: [],
   omnichannelSubscription: [
     [
       'retrieve',