Release v3.24.0

[cb-alish]

v3.24.0 (2026-05-04)

New Resources:

• QuoteEntitlement has been added.

New Actions:

• list_applicable_alerts_for_a_subscription has been added to Alert.
• retrieve_an_alert has been added to Alert.
• update_an_alert has been added to Alert.
• delete_an_alert has been added to Alert.
• list_alerts has been added to Alert.
• create_an_alert has been added to Alert.
• list_alert_statuses_for_a_subscription has been added to AlertStatus.
• list_alert_statuses_for_an_alert has been added to AlertStatus.

New Attributes:

• alarm_status has been added to AlertStatus.

New Parameters:

• limit has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.
• offset has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.
• status has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.
• type has been added as query parameter to list_applicable_alerts_for_a_subscription in Alert.
• limit has been added as query parameter to list_alerts in Alert.
• offset has been added as query parameter to list_alerts in Alert.
• id has been added as query parameter to list_alerts in Alert.
• type has been added as query parameter to list_alerts in Alert.
• subscription_id has been added as query parameter to list_alerts in Alert.
• status has been added as query parameter to list_alerts in Alert.
• limit has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.
• offset has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.
• alarm_status has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.
• alert_id has been added as query parameter to list_alert_statuses_for_a_subscription in AlertStatus.
• limit has been added as query parameter to list_alert_statuses_for_an_alert in AlertStatus.
• offset has been added as query parameter to list_alert_statuses_for_an_alert in AlertStatus.
• alarm_status has been added as query parameter to list_alert_statuses_for_an_alert in AlertStatus.
• exclude has been added as query parameter to list_invoices in Invoice.
• threshold has been added as request body parameter to update_an_alert in Alert.
• status has been added as request body parameter to update_an_alert in Alert.
• threshold has been added as request body parameter to create_an_alert in Alert.
• filter_conditions has been added as request body parameter to create_an_alert in Alert.
• type has been added as request body parameter to create_an_alert in Alert.
• name has been added as request body parameter to create_an_alert in Alert.
• description has been added as request body parameter to create_an_alert in Alert.
• metered_feature_id has been added as request body parameter to create_an_alert in Alert.
• subscription_id has been added as request body parameter to create_an_alert in Alert.
• meta has been added as request body parameter to create_an_alert in Alert.
• defer_payment_method_type has been added as request body parameter to create_a_payment_intent in PaymentIntent.
• net_term_days has been added as request body parameter to edit_quote_for_charge_items_and_charges in Quote.
• net_term_days has been added as request body parameter to create_a_quote_for_charge_and_charge_items in Quote.

Deleted Attributes:

• alarm_triggered_at has been removed from Alert.
• scope has been removed from Alert.
• alert_status has been removed from AlertStatus.

New Enums:

• within_limit and in_alarm have been added as new values enum AlarmStatus.
• moyasar and payway have been added as new values enum Gateway.
• absolute and percentage have been added as new values enum Mode.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values enum PaymentMethod.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values enum PaymentMethodType.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values enum Type.
• mada has been added as a new value to enum attribute card_type in Card.
• rate_limited has been added as a new value to enum attribute webhook_status in Event.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum attribute payment_method_type in PaymentIntent.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum attribute active_payment_attempt.payment_method_type in PaymentIntent.
• mada has been added as a new value to enum attribute card.brand in PaymentSource.
• plan_price, addon_price, charge_price, and charge have been added as new values to enum attribute entity_type in QuoteEntitlement.
• disabled and enabled have been added as new values to enum query parameter status.is in list_applicable_alerts_for_a_subscription of Alert.
• enabled and disabled have been added as new values to enum request body parameter status in update_an_alert of Alert.
• disabled and enabled have been added as new values to enum query parameter status.is in list_alerts of Alert.
• plan_price_id has been added as a new value to enum request body parameter filter_conditions.field in create_an_alert of Alert.
• not_equals and equals have been added as new values to enum request body parameter filter_conditions.operator in create_an_alert of Alert.
• rate_limited has been added as a new value to enum query parameter webhook_status.is in list_events of Event.
• rate_limited has been added as a new value to enum query parameter webhook_status.is_not in list_events of Event.
• rate_limited has been added as a new value to enum query parameter webhook_status.in in list_events of Event.
• rate_limited has been added as a new value to enum query parameter webhook_status.not_in in list_events of Event.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum request body parameter payment_method_type in update_a_payment_intent of PaymentIntent.
• twint, go_pay, grab_pay, pay_co, after_pay, swish, and payme have been added as new values to enum request body parameter payment_method_type in create_a_payment_intent of PaymentIntent.
• mada has been added as a new value to enum request body parameter card.brand in create_using_permanent_token of PaymentSource.

[snyk-io]

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

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	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: 5.0 - Moderate

View Breakdown

• Lines Changed: 631
• Files Changed: 25
• Complexity Added: 8
• Raw Score: 99.62

Overview

This PR releases version 3.24.0 of the Chargebee Node client, updating the client version and changelog accordingly.
It introduces a full Alert/AlertStatus API surface, a new QuoteEntitlement resource, and a FilterCondition model.
It also expands supported payment methods/gateways, adds new parameters to several APIs, and adjusts various enums and typings to align with the latest backend capabilities.

Key Changes

• Bumps the library to v3.24.0, documenting new APIs and enum values in CHANGELOG.md and updating the client version metadata.
• Adds full typed resource support and endpoints for Alert (create, retrieve, list, update, delete, and list applicable alerts for a subscription) including thresholds, statuses, and filter conditions.
• Adds typed resource support and endpoints for AlertStatus to list alert statuses by subscription or by alert, using a new AlarmStatusEnum (within_limit, in_alarm) instead of the old alert_status field.
• Introduces the QuoteEntitlement resource and FilterCondition type, with corresponding entries in endpoints and Content mappings so these objects can be returned in API responses.
• Extends various enums to support new gateways (moyasar, payway), modes (absolute, percentage), card brands (mada), webhook status (rate_limited), and multiple new payment method / payment method type values (twint, go_pay, grab_pay, pay_co, after_pay, swish, payme).
• Adds new request/query parameters to multiple APIs: listing alerts and alert statuses (filters, pagination, status/type), listing invoices (exclude filter), creating/updating alerts (threshold, status, filter conditions), creating payment intents (defer_payment_method_type), and quote charge/charge-items operations (net_term_days).
• Relaxes some field requirements and adds flexibility in payment flows by making PaymentIntent.gateway_account_id optional and allowing optional gateway_account_id in virtual bank account creation, plus broadening where the new payment method values are accepted across customer, estimate, gift, invoice, purchase, subscription, payment source, and payment intent types.
• Removes deprecated alert fields (Alert.alarm_triggered_at, Alert.scope, AlertStatus.alert_status) in favor of the new alarm status model and cleans up the now-circular AlertStatusEnum alias in core types.

Risks & Considerations

• The removal/renaming of alert-related fields (Alert.alarm_triggered_at, Alert.scope, AlertStatus.alert_status → alarm_status) is breaking for consumers relying on the old properties or types.
• Alert.type is now required, and new threshold/filter condition parameters may cause compile‑time errors or behavior changes in clients that pass objects not matching the updated typings.
• Making PaymentIntent.gateway_account_id optional and adding optional gateway_account_id for virtual bank accounts may expose cases where client code assumed this field was always present.
• The new alertStatu property name on the top-level client appears misspelled and may be a typo (alertStatus expected), which could lead to confusion or runtime issues if users try to access the resource by the correct name.
• Enum expansions (payment methods, gateways, webhook statuses) should be validated against backend support; misalignment could cause runtime API errors if the server is not yet aware of some values.

File-level change summary

File	Change summary
CHANGELOG.md	Adds v3.24.0 entry documenting new resources, actions, parameters, attributes, and enum values.
VERSION	Bumps library version from 3.23.1 to 3.24.0.
package-lock.json	Updates package metadata version to 3.24.0.
package.json	Updates NPM package version to 3.24.0.
src/environment.ts	Updates clientVersion constant to v3.24.0.
src/resources/api_endpoints.ts	Registers new quoteEntitlement, alert, alertStatus, and filterCondition endpoints with corresponding HTTP methods and paths.
types/core.d.ts	Extends core enums (e.g., AlarmStatusEnum, GatewayEnum, ModeEnum, payment method enums) and adjusts EntityTypeEnum while removing the circular AlertStatusEnum alias.
types/index.d.ts	Adds references for FilterCondition and QuoteEntitlement resource typings and exposes alert/alertStatu resources on the ChargeBee client.
types/resources/Alert.d.ts	Redefines Alert model and introduces the full Alert.AlertResource interface, request/response types, threshold and filter condition inputs, and list/filter parameters.
types/resources/AlertStatus.d.ts	Updates AlertStatus model to use alarm_status and adds AlertStatusResource with list-by-subscription and list-by-alert APIs and filterable inputs.
types/resources/Card.d.ts	Adds mada as a supported card brand in card details.
types/resources/Content.d.ts	Adds filter_condition and quote_entitlement to the union of content types that events/exports can return.
types/resources/Customer.d.ts	Extends payment method enums in offline payment detail sections to include new payment methods.
types/resources/Estimate.d.ts	Extends payment method enums in estimate payment detail sections to include new payment methods.
types/resources/Event.d.ts	Adds rate_limited to webhook_status enums used on events and event list filters.
types/resources/FilterCondition.d.ts	Introduces the FilterCondition interface for plan-price-based filter conditions.
types/resources/Gift.d.ts	Extends gift payment method enums to include new payment methods.
types/resources/Invoice.d.ts	Adds exclude filter to invoice list input and extends payment method enums in invoice payment details.
types/resources/PaymentIntent.d.ts	Makes gateway_account_id optional, adds defer_payment_method_type, and extends payment method enums across payment intent and payment attempt structures.
types/resources/PaymentSource.d.ts	Adds mada to card brand enums and extends payment method enums in payment source payment details and create APIs.
types/resources/Purchase.d.ts	Extends purchase payment method enums to include new payment methods.
types/resources/Quote.d.ts	Adds net_term_days request parameter to quote create/edit for charge items and charges.
types/resources/QuoteEntitlement.d.ts	Adds the QuoteEntitlement interface describing entitlements tied to plan/addon/charge prices on quotes.
types/resources/Subscription.d.ts	Extends subscription payment method enums in multiple contexts to include new payment methods.
types/resources/VirtualBankAccount.d.ts	Allows optional gateway_account_id for creating virtual bank accounts (both via permanent token and generic create).