Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
![hivel-marco[bot]](https://avatars.githubusercontent.com/in/2836183?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Complexity Score: 3.3 - Simple
View Breakdown
- Lines Changed: 198
- Files Changed: 10
- Complexity Added: 10
- Raw Score: 48.96
Overview
This PR releases Chargebee Ruby client v2.71.0, updating the gem version, metadata, and changelog. It introduces new models for QuoteEntitlement and FilterCondition, expands the Alert/AlertStatus API surface, and wires these into the Result helper. The changes align the client with newly available Chargebee API endpoints and fields for alerts and quote entitlements.
Key Changes
- Bumps the library version from 2.70.0 to 2.71.0, including gemspec date and Gemfile.lock updates, and documents the release in
CHANGELOG.md. - Adds the
QuoteEntitlementmodel and exposes it viaResult#quote_entitlementto support the new quote entitlements resource in API responses. - Adds the
FilterConditionmodel and exposes it viaResult#filter_condition, preparing the client to handle alert filter condition objects. - Extends the
Alertmodel with CRUD API operations and a subscription-scoped listing endpoint (application_alerts_for_subscription), while removing deprecated attributes (alarm_triggered_at,scope). - Updates
AlertStatusto usealarm_statusinstead ofalert_statusand adds listing operations by subscription and by alert.
Risks & Considerations
- The renaming/removal of attributes (
alarm_triggered_at,scope,alert_status→alarm_status) may break existing consumers relying on the old fields. - The method name
application_alerts_for_subscriptiondoes not exactly match the documented API action name (list_applicable_alerts_for_a_subscription), which could be confusing for users mapping SDK functions to API docs. - New models (
QuoteEntitlement,FilterCondition) are added without operations; their usage currently depends on responses only, so any future API evolution should ensure methods remain compatible. - None of the new API operations enforce parameter shapes at the client level, so incorrect usage will only be caught by server-side validation.
File-level change summary
| File | Change summary |
|---|---|
| CHANGELOG.md | Adds the v2.71.0 release notes detailing new resources, actions, attributes, parameters, deleted attributes, and enum values. |
| Gemfile.lock | Updates the local path gem version from 2.70.0 to 2.71.0. |
| VERSION | Increments the version string from 2.70.0 to 2.71.0. |
| chargebee.gemspec | Bumps gem version/date and includes new model files (filter_condition.rb, quote_entitlement.rb) in the file list. |
| lib/chargebee.rb | Updates the ChargeBee::VERSION constant to 2.71.0. |
| lib/chargebee/models/alert.rb | Removes deprecated attributes and adds CRUD and subscription-scoped listing operations for alerts. |
| lib/chargebee/models/alert_status.rb | Replaces alert_status with alarm_status and adds listing operations by subscription and by alert. |
| lib/chargebee/models/filter_condition.rb | Introduces a new FilterCondition model with field, operator, and value attributes. |
| lib/chargebee/models/quote_entitlement.rb | Introduces a new QuoteEntitlement model representing quote entitlement metadata. |
| lib/chargebee/result.rb | Adds accessors for quote_entitlement and filter_condition objects in API results. |
cb-karthikp
approved these changes
May 4, 2026
cb-karthikp
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
v2.71.0 (2026-05-04)
New Resources:
QuoteEntitlementhas been added.New Actions:
list_applicable_alerts_for_a_subscriptionhas been added toAlert.retrieve_an_alerthas been added toAlert.update_an_alerthas been added toAlert.delete_an_alerthas been added toAlert.list_alertshas been added toAlert.create_an_alerthas been added toAlert.list_alert_statuses_for_a_subscriptionhas been added toAlertStatus.list_alert_statuses_for_an_alerthas been added toAlertStatus.New Attributes:
alarm_statushas been added toAlertStatus.New Parameters:
limithas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.offsethas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.statushas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.typehas been added as query parameter tolist_applicable_alerts_for_a_subscriptioninAlert.limithas been added as query parameter tolist_alertsinAlert.offsethas been added as query parameter tolist_alertsinAlert.idhas been added as query parameter tolist_alertsinAlert.typehas been added as query parameter tolist_alertsinAlert.subscription_idhas been added as query parameter tolist_alertsinAlert.statushas been added as query parameter tolist_alertsinAlert.limithas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.offsethas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.alarm_statushas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.alert_idhas been added as query parameter tolist_alert_statuses_for_a_subscriptioninAlertStatus.limithas been added as query parameter tolist_alert_statuses_for_an_alertinAlertStatus.offsethas been added as query parameter tolist_alert_statuses_for_an_alertinAlertStatus.alarm_statushas been added as query parameter tolist_alert_statuses_for_an_alertinAlertStatus.excludehas been added as query parameter tolist_invoicesinInvoice.thresholdhas been added as request body parameter toupdate_an_alertinAlert.statushas been added as request body parameter toupdate_an_alertinAlert.thresholdhas been added as request body parameter tocreate_an_alertinAlert.filter_conditionshas been added as request body parameter tocreate_an_alertinAlert.typehas been added as request body parameter tocreate_an_alertinAlert.namehas been added as request body parameter tocreate_an_alertinAlert.descriptionhas been added as request body parameter tocreate_an_alertinAlert.metered_feature_idhas been added as request body parameter tocreate_an_alertinAlert.subscription_idhas been added as request body parameter tocreate_an_alertinAlert.metahas been added as request body parameter tocreate_an_alertinAlert.defer_payment_method_typehas been added as request body parameter tocreate_a_payment_intentinPaymentIntent.net_term_dayshas been added as request body parameter toedit_quote_for_charge_items_and_chargesinQuote.net_term_dayshas been added as request body parameter tocreate_a_quote_for_charge_and_charge_itemsinQuote.Deleted Attributes:
alarm_triggered_athas been removed fromAlert.scopehas been removed fromAlert.alert_statushas been removed fromAlertStatus.New Enums:
within_limitandin_alarmhave been added as new values enumAlarmStatus.moyasarandpaywayhave been added as new values enumGateway.absoluteandpercentagehave been added as new values enumMode.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values enumPaymentMethod.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values enumPaymentMethodType.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values enumType.madahas been added as a new value to enum attributecard_typeinCard.rate_limitedhas been added as a new value to enum attributewebhook_statusinEvent.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values to enum attributepayment_method_typeinPaymentIntent.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values to enum attributeactive_payment_attempt.payment_method_typeinPaymentIntent.madahas been added as a new value to enum attributecard.brandinPaymentSource.plan_price,addon_price,charge_price, andchargehave been added as new values to enum attributeentity_typeinQuoteEntitlement.disabledandenabledhave been added as new values to enum query parameterstatus.isinlist_applicable_alerts_for_a_subscriptionofAlert.enabledanddisabledhave been added as new values to enum request body parameterstatusinupdate_an_alertofAlert.disabledandenabledhave been added as new values to enum query parameterstatus.isinlist_alertsofAlert.plan_price_idhas been added as a new value to enum request body parameterfilter_conditions.fieldincreate_an_alertofAlert.not_equalsandequalshave been added as new values to enum request body parameterfilter_conditions.operatorincreate_an_alertofAlert.rate_limitedhas been added as a new value to enum query parameterwebhook_status.isinlist_eventsofEvent.rate_limitedhas been added as a new value to enum query parameterwebhook_status.is_notinlist_eventsofEvent.rate_limitedhas been added as a new value to enum query parameterwebhook_status.ininlist_eventsofEvent.rate_limitedhas been added as a new value to enum query parameterwebhook_status.not_ininlist_eventsofEvent.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values to enum request body parameterpayment_method_typeinupdate_a_payment_intentofPaymentIntent.twint,go_pay,grab_pay,pay_co,after_pay,swish, andpaymehave been added as new values to enum request body parameterpayment_method_typeincreate_a_payment_intentofPaymentIntent.madahas been added as a new value to enum request body parametercard.brandincreate_using_permanent_tokenofPaymentSource.