Releases: chargebee/chargebee-java
Releases · chargebee/chargebee-java
v4.0.0
Releasing v4.x.x 🎉 🎉
v4.0.0 (2026-01-13)
- This is a complete rewrite of the Chargebee Java SDK with a new package namespace (
com.chargebee.v4). - The client library now uses an immutable
ChargebeeClientwith a fluent builder pattern instead of staticEnvironmentconfiguration. - All request and response models are now type-safe and immutable.
See the migration guide for details.
New Features:
- Immutable
ChargebeeClientwith fluent builder configuration. - Type-safe request parameter models and responses.
- Sync and async APIs with built-in retry and exponential backoff support.
- Per-request options for custom headers and retry configuration.
- Enhanced exception hierarchy with strongly-typed error enums (
ErrorType,ApiErrorCode). - Webhook handler support for event processing.
- Helper methods in response objects to get raw response and headers.
🔴 Attention: The support for v3 will eventually be discontinued on December 31st 2026 and will no longer receive any further updates. We strongly recommend upgrading to v4 as soon as possible. See our migration guide for detailed upgrade instructions.
💡 Rest assured: Your existing v3 integrations will continue to function. After December 31st 2026, v3 will no longer receive updates for new API features, but all current functionality will remain operational.
v3.41.0
v3.40.0
v3.40.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.
v4.0.0-beta.3
What's Changed
- Testcase for transport and url pattern by @cb-karthikp in #59
- Next version update by @cb-karthikp in #63
- exception handling, webhook handler by @cb-karthikp in #65
Full Changelog: v4.0.0-beta.1...v4.0.0-beta.3
v3.39.0
v3.39.0 (2025-11-26)
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.
v3.38.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.
v4.0.0-beta.1
v4.0.0-beta.1
v3.37.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.
v3.36.1
v3.36.1 (2025-09-16)
Deprecated Attribute:
- The
messagefield has been made private in APIException, as it has long been deprecated. - Users should use the
getMessage()method instead, as documented in the comments.
New Exception
- New
APIExceptionUbbBatchIngestionInvalidRequestExceptionhas been added.
v3.36.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.