Releases: chargebee/chargebee-ruby
Releases · chargebee/chargebee-ruby
v2.68.0
v2.68.0 (2026-02-06)
New Attributes:
subscription_idhas been added toEntitlementOverride.is_enabledhas been added toEntitlementOverride.decommissionedhas been added toSubscription.
New Parameters:
omnichannel_subscription_itemhas been added as query parameter tolist_omnichannel_subscriptionsinOmnichannelSubscription.entitlement_overrides.entity_idhas been added as request body parameter toupsert_or_remove_entitlement_overrides_for_a_subscriptioninEntitlementOverride.entitlement_overrides.entity_typehas been added as request body parameter toupsert_or_remove_entitlement_overrides_for_a_subscriptioninEntitlementOverride.entitlement_overrides.is_enabledhas been added as request body parameter toupsert_or_remove_entitlement_overrides_for_a_subscriptioninEntitlementOverride.payment_method_save_policyhas been added as request body parameter tocollect_nowinHostedPage.decommissionedhas been added as request body parameter tocancel_subscription_for_itemsinSubscription.
Parameter Updates:
pricing_pagehas been changed from required to optional increate_pricing_page_for_existing_subscriptionofPricingPageSession.
New Events:
payment_due_reminderhas been added.
New Enums:
chargehas been added as a new value enumEntityType.payment_due_reminderhas been added as a new value enumEventType.tempushas been added as a new value enumGateway.kakao_pay,naver_pay,revolut_pay, andcash_app_payhave been added as new values enumPaymentMethod.always,ask, andneverhave been added as new values enumPaymentMethodSavePolicy.kakao_pay,naver_pay,revolut_pay, andcash_app_payhave been added as new values enumPaymentMethodType.kakao_pay,naver_pay,revolut_pay, andcash_app_payhave been added as new values enumType.accepted,rejected,message_acknowledgement,in_process,under_query,conditionally_accepted, andpaidhave been added as new values to enum attributeeinvoice.statusinCreditNote.accepted,rejected,message_acknowledgement,in_process,under_query,conditionally_accepted, andpaidhave been added as new values to enum attributestatusinEinvoice.accepted,rejected,message_acknowledgement,in_process,under_query,conditionally_accepted, andpaidhave been added as new values to enum attributeeinvoice.statusinInvoice.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum attributepayment_method_typeinPaymentIntent.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum attributeactive_payment_attempt.payment_method_typeinPaymentIntent.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum request body parameterpayment_method_typeinupdate_a_payment_intentofPaymentIntent.kakao_pay,naver_pay,revolut_pay,cash_app_pay,wechat_pay, andalipayhave been added as new values to enum request body parameterpayment_method_typeincreate_a_payment_intentofPaymentIntent.
v2.67.0
v3.67.0 (2026-01-16)
New Parameters:
applicable_item_price_idshas been added to Coupon#CouponListRequest.applicable_item_price_idshas been added to Export#CouponRequest.
New Enums:
Twikeyhas been added to GatewayEnum.
Deleted Action:
moveaction has been removed from the ItemPrice.
v2.66.0
v2.66.0 (2025-12-30)
New Attributes:
- retry_engine has been added to Invoice#DunningAttempt.
New Endpoint:
- move action has been added to ItemPrice.
New Parameters:
- exclude_tax_type has been added to Estimate#RenewalEstimateInputParam.
- variant_id has been added to ItemPrice#MoveInputParam.
- custom has been added to PricingPageSession#CreateForNewSubscriptionInputParam.
- custom has been added to PricingPageSession#CreateForExistingSubscriptionInputParam.
New Enums:
- ELECTRONIC_PAYMENT_STANDARD has been added to PaymentMethodTypeEnum.
- KBC_PAYMENT_BUTTON has been added to PaymentMethodTypeEnum.
- PAY_BY_BANK has been added to PaymentMethodTypeEnum.
- TRUSTLY has been added to PaymentMethodTypeEnum.
- STABLECOIN has been added to PaymentMethodTypeEnum.
v2.65.0
New Resources:
- Einvoice has been added.
- QuotedDeltaRamp has been added.
New Attributes:
- line_items_next_offset has been added to CreditNote.
- line_items_next_offset has been added to Invoice.
- credit_lines has been added to SalesOrder.
- billable_unit_price has been added to SalesOrder#LineItem.
- billable_quantity has been added to SalesOrder#LineItem.
- billable_amount has been added to SalesOrder#LineItem.
New Endpoint:
- move has been added to ItemPrice.
New Parameters:
- line_items_limit has been added to CreditNote#RetrieveRequest.
- line_items_offset has been added to CreditNote#RetrieveRequest.
- line_items_limit has been added to Invoice#RetrieveRequest.
- line_items_offset has been added to Invoice#RetrieveRequest.
- item_tiers has been added to Estimate#GiftSubscriptionForItemsRequest.
- unit_price has been added to Estimate#SubscriptionItems#GiftSubscriptionForItemsRequest.
- unit_price_in_decimal has been added to Estimate#SubscriptionItems#GiftSubscriptionForItemsRequest.
- item_tiers has been added to Gift#CreateForItemsRequest.
- meta_data has been added to Gift#CreateForItemsRequest.
- unit_price has been added to Gift#SubscriptionItems#CreateForItemsRequest.
- unit_price_in_decimal has been added to Gift#SubscriptionItems#CreateForItemsRequest.
- item_tiers has been added to HostedPage#CheckoutGiftForItemsRequest.
- unit_price has been added to HostedPage#SubscriptionItems#CheckoutGiftForItemsRequest.
- unit_price_in_decimal has been added to HostedPage#SubscriptionItems#CheckoutGiftForItemsRequest.
- auto_select_local_currency has been added to PricingPageSession#CreateForNewSubscriptionRequest.
New Enums:
- EZIDEBIT has been added to GatewayEnum.
- BUSINESS_RULE has been added to EntityTypeEnum.
- RULESET has been added to EntityTypeEnum.
v2.64.0
v2.64.0 (2025-11-10)
Error Handling
- Added new
ForbiddenErrorclass that inherits fromError - Enhanced
handle_for_errormethod to detect and handle 403 status codes - Provides clear error message: "Access forbidden. You do not have permission to access this resource."
Code Quality Improvements
- Renamed
lib/chargebee/nativeRequest.rb→lib/chargebee/native_request.rbto follow Ruby naming conventions - Refactored
handle_for_errorto return error objects instead of raising them inline (cleaner separation of concerns) - Added YARD documentation for
handle_for_errormethod
v2.63.0
New Attributes:
- reference_transactions has been added to Invoice.
- payment_attempts[] has been added to PaymentIntent.
- checkout_details has been added to PaymentIntent#PaymentAttempt.
- line_item_id has been added to CreditNoteEstimate#Discount.
- line_item_id has been added to CreditNote#Discount.
- line_item_id has been added to InvoiceEstimate#Discount.
- line_item_id has been added to Invoice#Discount.
- line_item_id has been added to InvoiceEstimate#Discount.
- line_item_id has been added to Quote#Discount.
- line_item_id has been added to QuoteLineGroup#Discount.
Modified Attributes:
- omnichannel_subscription_item_offers has been made optional attribute from required attribute.
New Input Parameters:
- discount[line_item_id] has been added to CreditNote#ImportCreditNoteRequest.
- discount[line_item_id] has been added to CreditNote#ImportInvoiceRequest.
New Enums:
- OMNICHANNEL_TRANSACTION_CREATED has been added to EventTypeEnum.
- DEUTSCHE_BANK has been added to Gateway.
v2.62.0
v2.61.0
New Resources:
- PersonalizedOffer has been added.
- OfferFulfillment has been added.
- OfferEvent has been added.
- OmnichannelSubscriptionItemOffer has been added.
New Attributes:
- business_entity_id has been added to Customer#Balance.
- processor_advice_code has been added to GatewayErrorDetail.
- processor_advice_code has been added to Transaction#GatewayErrorDetail.
- omnichannel_subscription_item_offers has been added to OmnichannelSubscriptionItem.
- linked_omnichannel_subscriptions has been added to OmnichannelTransaction.
- linked_omnichannel_one_time_orders has been added to OmnichannelTransaction.
- contract_term has been added to Ramp.
- charge_once has been added to Ramp#ItemsToAdd.
- charge_on_option has been added to Ramp#ItemsToAdd.
- charge_on_event has been added to Ramp#ItemsToAdd.
- charge_once has been added to Ramp#ItemsToUpdate.
- charge_on_option has been added to Ramp#ItemsToUpdate.
- charge_on_event has been added to Ramp#ItemsToUpdate.
- error_file_path has been added to UsageFile.
- error_file_url has been added to UsageFile.
New Endpoint:
- move has been added to OmnichannelSubscription.
New Parameters:
- offline_payment_method has been added to Estimate#CreateSubItemEstimateRequest.
- offline_payment_method has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
- offline_payment_method has been added to HostedPage#CheckoutNewForItemsRequest.
- offline_payment_method has been added to Quote#SubscriptionCreateSubItemsForCustomerQuoteRequest.
- offline_payment_method has been added to Quote#SubscriptionEditCreateSubCustomerQuoteForItemsRequest.
- contract_term has been added to Ramp#CreateForSubscriptionRequest.
- items_to_add has been added to Ramp#CreateForSubscriptionRequest.
- items_to_update has been added to Ramp#CreateForSubscriptionRequest.
- contract_term has been added to Ramp#UpdateRequest.
- items_to_add has been added to Ramp#UpdateRequest.
- items_to_update has been added to Ramp#UpdateRequest.
New Enums:
- DUNNING_UPDATED has been added EventType.
- OMNICHANNEL_SUBSCRIPTION_MOVED_IN has been added to EventType.
Bug Fixes:
- currency list action has been marked as ListRequest.
- index has been removed from CreditNote#ShippingAddress.
- index has been removed from Invoice#ShippingAddress
- index has been removed from Order#ShippingAddress.
- index has been removed from Quote#ShippingAddress.
- index has been removed from SubscriptionEstimate#ShippingAddress.
- index has been removed from Subscription#ShippingAddress.
v2.60.0
v2.59.0
New Resources:
- WebhookEndpoints has been added.
- OmnichannelOneTimeOrder has been added.
- OmnichannelOneTimeOrderItem has been added.
New Attributes:
- business_entity_id has been added to Comment.
- business_entity_id has been added to PromotionalCredit.
- quantity has been added to Discount.
- business_entity_id has been added to PromotionalCredit.
- coupon_applicability_mappings[] has been added to QuotedCharge.
- linked_omnichannel_one_time_orders[] has been added to RecordedPurchase.
- quantity has been added to Subscripiton#Discount.
New Input Parameters:
- transaction[id] has been added to Customer#RecordExcessPaymentRequest.
- discounts[quantity][] has been added to Estimate#CreateSubItemEstimateRequest.
- consolidate_entitlements has been added to CustomerEntitlement#EntitlementsForCustomer.
- discounts[quantity][] has been added to Estimate#CreateSubItemEstimateRequest.
- discounts[quantity][] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
- discounts[quantity][] has been added to Estimate#UpdateSubscriptionForItemsRequest.
- discounts[quantity][] has been added to Estimate#CreateInvoiceForItemsRequest.
- discounts[quantity][] has been added to HostedPage#CheckoutOneTimeForItemsRequest.
- discounts[quantity][] has been added to HostedPage#CheckoutNewForItemsRequest.
- discounts[quantity][] has been added to HostedPage#CheckoutExistingForItemsRequest.
- discounts[quantity][] has been added to PricingPageSession#CreateForNewSubscriptionRequest.
- discounts[quantity][] has been added to PricingPageSession#CreateForExistingSubscriptionRequest.
- discounts[quantity][] has been added to Purchase#CreateRequest.
- discounts[quantity][] has been added to Purchase#EstimateRequest.
- discounts[quantity][] has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
- discounts[quantity][] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
- discounts[quantity][] has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
- discounts[quantity][] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
- discounts[quantity][] has been added to Quote#CreateForChargeItemsAndChargesRequest.
- discounts[quantity][] has been added to Quote#EditForChargeItemsAndChargesRequest.
- discounts[quantity][] has been added to Subscription#CreateWithItemsRequest.
- discounts[quantity][] has been added to Subscription#UpdateForItemsRequest.
- discounts[quantity][] has been added to Subscription#ImportForItemsRequest.
- google_play_store[product_id] has been added to RecordedPurchase#CreateRequest.
- google_play_store[order_id] has been added to RecordedPurchase#CreateRequest.
New Enums
- PAUSE has been added to OmnichannelSubscriptionItemScheduledChange#ChangeType.
- OFFER_QUANTITY has been added to Discount#Type.
- OFFER_QUANTITY has been added to Subscription#Discount#Type.
- OMNICHANNEL_ONE_TIME_ORDER has been added to EntityType.
- OMNICHANNEL_ONE_TIME_ORDER_ITEM has been added to EntityType.
- USAGE_FILE has been added to EntityType.
- OMNICHANNEL_ONE_TIME_ORDER_CREATED has been added to EventType.
- OMNICHANNEL_ONE_TIME_ORDER_ITEM_CANCELLED has been added to EventType.
- USAGE_FILE_INGESTED has been added to EventType.
- OMNICHANNEL_SUBSCRIPTION_ITEM_PAUSE_SCHEDULED has been added to EventType.