chargebee 2.55.0 → 2.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08c00f3c33087b3539f16d88e278b1d1f0e49d41
-  data.tar.gz: 14cca643852e1b99872d80f46e749e914f9fa018
+  metadata.gz: 001c016fe4fc0205f06fb61eb647d42281538059
+  data.tar.gz: f833505b1779675814ddc724904de2cb9f12cb8d
 SHA512:
-  metadata.gz: 8e706d3f71e25154f4e2712e3977b5269d0aefa7ac63a8c7c6f4f63119b2159f4a3da4739b67785e08dc4f2c6d41ed8606fa0adb33a8f6d863a8fb1ff1791a88
-  data.tar.gz: ba9875acbd1b53b3e207cc4fa6f2a790b493a6d3a2a623447ac8ba989cb050eb39140ef3f1aafc13a75109a41bfe94eedb20b92df859b52fa5007b639c37696b
+  metadata.gz: 37f8ec23a423df351454d67c8d1a74eb4cd595b2364ac4b31033afa7fe318b815d0f07676c380e6916a1470182347d2d3c3c45cf1aa9fabecb695dcef9a2ed86
+  data.tar.gz: 3b3c3d6dbfe8556c2d1b4679aaf7316c966180b5b596295873edb219967adc51ced19e0ac7dd5c99a97160a4a3b96d88b63cef3d9fb60821a784fe5b24b5d732

data/CHANGELOG.md

@@ -1,3 +1,68 @@
+### v2.56.0 (2025-06-19) 
+* * * 
+
+### New Resources 
+* QuotedRamp has been added.
+
+### New Attributes
+* chargebee_response_schema_type has been added to Configuration.
+* linked_item has been added to OmnichannelSubscriptionItem.
+* resumes_at has been added to OmnichannelSubscriptionItem.
+
+### Changed Attributes
+* percentage changed to is_percentage_pricing in CreditNote.
+* percentage changed to is_percentage_pricing in QuoteLineGroup.
+* percentage changed to is_percentage_pricing in CreditNoteEstimate.
+* percentage changed to is_percentage_pricing in Invoice.
+* percentage changed to is_percentage_pricing in InvoiceEstimate.
+* percentage changed to is_percentage_pricing in Quote.
+
+
+### New Input Parameters
+* is_percentage_pricing has been added to Item#UpdateRequest.
+* line_item[subscription_id] has been added to CreditNote#RetrieveRequest.
+* line_item[customer_id] has been added to CreditNote#RetrieveRequest.
+* line_item[subscription_id] has been added to Invoice#RetrieveRequest.
+* line_item[customer_id] has been added to Invoice#RetrieveRequest.
+* billing_override[max_excess_payment_usage] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* billing_override[max_refundable_credits_usage] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* billing_override[max_excess_payment_usage] has been added to Estimate#UpdateSubscriptionForItemsRequest.
+* billing_override[max_refundable_credits_usage] has been added to Estimate#UpdateSubscriptionForItemsRequest.
+* billing_start_option has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* net_term_days has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* billing_address has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* subscription_items has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* discounts has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* billing_start_option has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* net_term_days has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* billing_address has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* subscription_items has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* discounts has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* net_term_days has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
+* subscription_items has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
+* discount has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
+* coupons has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
+* net_term_days has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* subscription_items has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* discounts has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* coupons has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* billing_address has been added to Quote#CreateForChargeItemsAndChargesRequest.
+* billing_address has been added to Quote#EditForChargeItemsAndChargesRequest.
+* sort_by[order] has been added to Subscription#SubscriptionContractTermsForSubscriptionRequest.
+* item_tiers has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
+* item_tiers has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* item_tiers has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* item_tiers has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+
+### New Endpoints: 
+* PauseDunningRequest has been added to Invoice.
+* ResumeDunningRequest has been added to Invoice.
+
+### Enum Attributes: 
+* BillingPeriodUnitEnum has been added.
+* BillingStartOptionEnum has been added.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_RESUMED has been added to EventTypeEnum.
+
 ### v2.55.0 (2025-06-03)
 * * * 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.55.0)
+    chargebee (2.56.0)
       cgi (>= 0.1.0, < 1.0.0)
 
 GEM

data/chargebee.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
   s.required_ruby_version = '>= 1.9.3'
   s.name              = 'chargebee'
-  s.version           = '2.55.0'
-  s.date              = '2025-06-03'
+  s.version           = '2.56.0'
+  s.date              = '2025-06-19'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -108,6 +108,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/quote.rb
     lib/chargebee/models/quote_line_group.rb
     lib/chargebee/models/quoted_charge.rb
+    lib/chargebee/models/quoted_ramp.rb
     lib/chargebee/models/quoted_subscription.rb
     lib/chargebee/models/ramp.rb
     lib/chargebee/models/recorded_purchase.rb

data/lib/chargebee/models/configuration.rb

@@ -1,7 +1,7 @@
 module ChargeBee
   class Configuration < Model
 
-  attr_accessor :domain, :product_catalog_version
+  attr_accessor :domain, :product_catalog_version, :chargebee_response_schema_type
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/credit_note.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :is_percentage_pricing, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model
@@ -75,10 +75,10 @@ module ChargeBee
     Request.send('post', uri_path("credit_notes"), params, env, headers,nil, false, jsonKeys)
   end
 
-  def self.retrieve(id, env=nil, headers={})
+  def self.retrieve(id, params={}, env=nil, headers={})
     jsonKeys = {
     }
-    Request.send('get', uri_path("credit_notes",id.to_s), {}, env, headers,nil, false, jsonKeys)
+    Request.send('get', uri_path("credit_notes",id.to_s), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.pdf(id, params={}, env=nil, headers={})

data/lib/chargebee/models/credit_note_estimate.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class CreditNoteEstimate < Model
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :is_percentage_pricing, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/invoice.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Invoice < Model
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :is_percentage_pricing, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model
@@ -54,7 +54,7 @@ module ChargeBee
     end
 
     class Note < Model
-      attr_accessor :entity_type, :note, :entity_id
+      attr_accessor :note, :entity_id, :entity_type
     end
 
     class ShippingAddress < Model
@@ -141,6 +141,18 @@ module ChargeBee
     Request.send('post', uri_path("invoices",id.to_s,"stop_dunning"), params, env, headers,nil, false, jsonKeys)
   end
 
+  def self.pause_dunning(id, params, env=nil, headers={})
+    jsonKeys = {
+    }
+    Request.send('post', uri_path("invoices",id.to_s,"pause_dunning"), params, env, headers,nil, false, jsonKeys)
+  end
+
+  def self.resume_dunning(id, params={}, env=nil, headers={})
+    jsonKeys = {
+    }
+    Request.send('post', uri_path("invoices",id.to_s,"resume_dunning"), params, env, headers,nil, false, jsonKeys)
+  end
+
   def self.import_invoice(params, env=nil, headers={})
     jsonKeys = {
     }
@@ -189,10 +201,10 @@ module ChargeBee
     Request.send('get', uri_path("subscriptions",id.to_s,"invoices"), params, env, headers,nil, false, jsonKeys)
   end
 
-  def self.retrieve(id, env=nil, headers={})
+  def self.retrieve(id, params={}, env=nil, headers={})
     jsonKeys = {
     }
-    Request.send('get', uri_path("invoices",id.to_s), {}, env, headers,nil, false, jsonKeys)
+    Request.send('get', uri_path("invoices",id.to_s), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.pdf(id, params={}, env=nil, headers={})

data/lib/chargebee/models/invoice_estimate.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class InvoiceEstimate < Model
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :is_percentage_pricing, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/omnichannel_subscription_item.rb

@@ -5,9 +5,14 @@ module ChargeBee
       attr_accessor :price_currency, :price_units, :price_nanos
     end
 
+    class LinkedItem < Model
+      attr_accessor :id, :linked_at
+    end
+
   attr_accessor :id, :item_id_at_source, :item_parent_id_at_source, :status, :auto_renew_status,
   :current_term_start, :current_term_end, :expired_at, :expiration_reason, :cancelled_at, :cancellation_reason,
-  :grace_period_expires_at, :has_scheduled_changes, :resource_version, :upcoming_renewal
+  :grace_period_expires_at, :resumes_at, :has_scheduled_changes, :resource_version, :upcoming_renewal,
+  :linked_item
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/quote.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Quote < Model
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :is_percentage_pricing, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model
@@ -39,7 +39,7 @@ module ChargeBee
   :updated_at, :vat_number_prefix, :line_items, :discounts, :line_item_discounts, :taxes, :line_item_taxes,
   :line_item_tiers, :tax_category, :currency_code, :notes, :shipping_address, :billing_address,
   :contract_term_start, :contract_term_end, :contract_term_termination_fee, :business_entity_id,
-  :deleted
+  :deleted, :total_contract_value, :total_discount
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/quote_line_group.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class QuoteLineGroup < Model
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :metered, :is_percentage_pricing, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/quoted_ramp.rb

@@ -0,0 +1,22 @@
+module ChargeBee
+  class QuotedRamp < Model
+
+    class LineItem < Model
+      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :start_date, :end_date, :ramp_tier_id, :discount_amount, :md_discount_amount, :item_level_discount_amount, :md_item_level_discount_amount, :discount_per_billing_cycle, :discount_per_billing_cycle_in_decimal, :item_level_discount_per_billing_cycle, :item_level_discount_per_billing_cycle_in_decimal, :net_amount, :md_net_amount, :amount_per_billing_cycle, :amount_per_billing_cycle_in_decimal, :net_amount_per_billing_cycle, :net_amount_per_billing_cycle_in_decimal
+    end
+
+    class Discount < Model
+      attr_accessor :id, :name, :invoice_name, :type, :percentage, :amount, :duration_type, :entity_type, :entity_id, :period, :period_unit, :included_in_mrr, :apply_on, :apply_on_item_type, :item_price_id, :created_at, :updated_at, :start_date, :end_date
+    end
+
+    class ItemTier < Model
+      attr_accessor :item_price_id, :starting_unit, :ending_unit, :price, :starting_unit_in_decimal, :ending_unit_in_decimal, :price_in_decimal, :ramp_tier_id
+    end
+
+  attr_accessor :id, :line_items, :discounts, :item_tiers
+
+  # OPERATIONS
+  #-----------
+
+  end # ~QuotedRamp
+end # ~ChargeBee

data/lib/chargebee/result.rb

@@ -201,6 +201,12 @@ module ChargeBee
         return quoted_charge;
     end
 
+    def quoted_ramp() 
+        quoted_ramp = get(:quoted_ramp, QuotedRamp,
+        {:line_items => QuotedRamp::LineItem, :discounts => QuotedRamp::Discount, :item_tiers => QuotedRamp::ItemTier});
+        return quoted_ramp;
+    end
+
     def quote_line_group() 
         quote_line_group = get(:quote_line_group, QuoteLineGroup,
         {:line_items => QuoteLineGroup::LineItem, :discounts => QuoteLineGroup::Discount, :line_item_discounts => QuoteLineGroup::LineItemDiscount, :taxes => QuoteLineGroup::Tax, :line_item_taxes => QuoteLineGroup::LineItemTax});
@@ -450,7 +456,7 @@ module ChargeBee
         omnichannel_subscription = get(:omnichannel_subscription, OmnichannelSubscription, {},
         {:omnichannel_subscription_items => OmnichannelSubscriptionItem});
         omnichannel_subscription.init_dependant_list(@response[:omnichannel_subscription], :omnichannel_subscription_items,
-        {:upcoming_renewal => OmnichannelSubscriptionItem::UpcomingRenewal});
+        {:upcoming_renewal => OmnichannelSubscriptionItem::UpcomingRenewal, :linked_item => OmnichannelSubscriptionItem::LinkedItem});
         return omnichannel_subscription;
     end
 
@@ -461,7 +467,7 @@ module ChargeBee
 
     def omnichannel_subscription_item() 
         omnichannel_subscription_item = get(:omnichannel_subscription_item, OmnichannelSubscriptionItem,
-        {:upcoming_renewal => OmnichannelSubscriptionItem::UpcomingRenewal});
+        {:upcoming_renewal => OmnichannelSubscriptionItem::UpcomingRenewal, :linked_item => OmnichannelSubscriptionItem::LinkedItem});
         return omnichannel_subscription_item;
     end
 

data/lib/chargebee.rb

@@ -87,11 +87,12 @@ require File.dirname(__FILE__) + '/chargebee/models/usage_event'
 require File.dirname(__FILE__) + '/chargebee/models/rule'
 require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item_scheduled_change'
 require File.dirname(__FILE__) + '/chargebee/models/usage_file'
+require File.dirname(__FILE__) + '/chargebee/models/quoted_ramp'
 
 
 module ChargeBee
 
-  VERSION = '2.55.0'
+  VERSION = '2.56.0'
 
   @@default_env = nil
   @@verify_ca_certs = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.55.0
+  version: 2.56.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-03 00:00:00.000000000 Z
+date: 2025-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -149,6 +149,7 @@ files:
 - lib/chargebee/models/quote.rb
 - lib/chargebee/models/quote_line_group.rb
 - lib/chargebee/models/quoted_charge.rb
+- lib/chargebee/models/quoted_ramp.rb
 - lib/chargebee/models/quoted_subscription.rb
 - lib/chargebee/models/ramp.rb
 - lib/chargebee/models/recorded_purchase.rb