Releasing v2.68.0

cb-alish · cb-alish · commit 54185ec1e7dd · 2026-03-02T11:46:58.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,32 @@
+### v2.68.0 (2026-03-02)
+* * *
+### New Resources:
+- [`UsageCharge`](https://apidocs.chargebee.com/docs/api/usage_charges) has been added.
+- [`UsageSummary`](https://apidocs.chargebee.com/docs/api/usage_summaries) has been added.
+
+
+### New Attributes:
+- [`free_period`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions/quoted-subscription-object#free_period) has been added to [`QuotedSubscription`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions).
+- [`free_period_unit`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions/quoted-subscription-object#free_period_unit) has been added to [`QuotedSubscription`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions).
+
+
+### New Parameters:
+- [`net_term_days`](https://apidocs.chargebee.com/docs/api/invoices/create-invoice-for-items-and-one-time-charges#net_term_days) has been added as request body parameter to [`create_invoice_for_items_and_one-time_charges`](https://apidocs.chargebee.com/docs/api/invoices/create-invoice-for-items-and-one-time-charges) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- [`contract_term`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription#contract_term) has been added as request body parameter to [`create_pricing_page_for_existing_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription) in [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+- [`contract_term`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription#contract_term) has been added as request body parameter to [`create_pricing_page_for_new_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription) in [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+- [`subscription.free_period`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_free_period) has been added as request body parameter to [`create_a_quote_for_a_new_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription.free_period_unit`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_free_period_unit) has been added as request body parameter to [`create_a_quote_for_a_new_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription.free_period`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#subscription_free_period) has been added as request body parameter to [`edit_create_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription.free_period_unit`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#subscription_free_period_unit) has been added as request body parameter to [`edit_create_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+
+
+### New Enums:
+- `month`, `week`, `day`, `hour`, and `minute` have been added as new values enum `WindowSize`.
+- `cancel`, `renew_once`, `renew`, and `evergreen` have been added as new values to enum request body parameter `contract_term.action_at_term_end` in [`create_pricing_page_for_existing_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription) of [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+- `cancel`, `renew_once`, `renew`, and `evergreen` have been added as new values to enum request body parameter `contract_term.action_at_term_end` in [`create_pricing_page_for_new_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription) of [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+
+
+
 ### v3.67.0 (2026-01-16)
 * * * 
 
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.67.0)
+    chargebee (2.68.0)
       cgi (>= 0.1.0, < 1.0.0)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     bigdecimal (3.2.2)
-    cgi (0.3.2)
+    cgi (0.5.1)
     crack (1.0.0)
       bigdecimal
       rexml
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.67.0
+2.68.0
diff --git a/chargebee.gemspec b/chargebee.gemspec
@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
   s.required_ruby_version = '>= 1.9.3'
   s.name              = 'chargebee'
-  s.version           = '2.67.0'
+  s.version           = '2.68.0'
   s.date              = '2026-01-16'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
diff --git a/lib/chargebee.rb b/lib/chargebee.rb
@@ -100,7 +100,7 @@
 
 module ChargeBee
 
-  VERSION = '2.67.0'
+  VERSION = '2.68.0'
 
   @@default_env = nil
   @@verify_ca_certs = true
diff --git a/lib/chargebee/models/entitlement_override.rb b/lib/chargebee/models/entitlement_override.rb
@@ -1,8 +1,8 @@
 module ChargeBee
   class EntitlementOverride < Model
 
-  attr_accessor :id, :entity_id, :entity_type, :feature_id, :feature_name, :value, :name, :expires_at,
-  :effective_from, :schedule_status
+  attr_accessor :id, :subscription_id, :entity_id, :entity_type, :feature_id, :feature_name, :value,
+  :name, :expires_at, :effective_from, :is_enabled, :schedule_status
 
   # OPERATIONS
   #-----------
diff --git a/lib/chargebee/models/quoted_subscription.rb b/lib/chargebee/models/quoted_subscription.rb
@@ -28,8 +28,8 @@ class QuotedContractTerm < Model
   attr_accessor :id, :plan_id, :plan_quantity, :plan_unit_price, :setup_fee, :billing_period,
   :billing_period_unit, :start_date, :trial_end, :remaining_billing_cycles, :po_number, :auto_collection,
   :plan_quantity_in_decimal, :plan_unit_price_in_decimal, :changes_scheduled_at, :change_option,
-  :contract_term_billing_cycle_on_renewal, :addons, :event_based_addons, :coupons, :subscription_items,
-  :item_tiers, :quoted_contract_term
+  :free_period, :free_period_unit, :contract_term_billing_cycle_on_renewal, :addons, :event_based_addons,
+  :coupons, :subscription_items, :item_tiers, :quoted_contract_term
 
   # OPERATIONS
   #-----------
diff --git a/lib/chargebee/models/subscription.rb b/lib/chargebee/models/subscription.rb
@@ -62,7 +62,7 @@ class Discount < Model
   :addons, :event_based_addons, :charged_event_based_addons, :coupon, :coupons, :shipping_address,
   :referral_info, :billing_override, :invoice_notes, :meta_data, :deleted, :changes_scheduled_at,
   :contract_term, :cancel_reason_code, :free_period, :free_period_unit, :create_pending_invoices,
-  :auto_close_invoices, :discounts, :business_entity_id, :metadata
+  :auto_close_invoices, :discounts, :business_entity_id, :decommissioned, :metadata
     def metadata
     warn "[DEPRECATION] `metadata` is deprecated please use meta_data instead."
     @metadata
diff --git a/lib/chargebee/models/usage_charge.rb b/lib/chargebee/models/usage_charge.rb
@@ -0,0 +1,19 @@
+module ChargeBee
+  class UsageCharge < Model
+
+  attr_accessor :subscription_id, :feature_id, :included_usage, :total_usage, :on_demand_usage,
+  :metered_item_price_id, :amount, :currency_code, :usage_from, :usage_to
+
+  # OPERATIONS
+  #-----------
+
+  # @deprecated This method is deprecated and will be removed in a future version.
+  def self.retrieve_usage_charges_for_subscription(id, params={}, env=nil, headers={})
+    jsonKeys = { 
+    }
+    options = {}
+    Request.send('get', uri_path("subscriptions",id.to_s,"usage_charges"), params, env, headers,nil, false, jsonKeys, options)
+  end
+
+  end # ~UsageCharge
+end # ~ChargeBee
diff --git a/lib/chargebee/models/usage_summary.rb b/lib/chargebee/models/usage_summary.rb
@@ -0,0 +1,18 @@
+module ChargeBee
+  class UsageSummary < Model
+
+  attr_accessor :subscription_id, :feature_id, :aggregated_value, :aggregated_from, :aggregated_to
+
+  # OPERATIONS
+  #-----------
+
+  # @deprecated This method is deprecated and will be removed in a future version.
+  def self.retrieve_usage_summary_for_subscription(id, params, env=nil, headers={})
+    jsonKeys = { 
+    }
+    options = {}
+    Request.send('get', uri_path("subscriptions",id.to_s,"usage_summary"), params, env, headers,nil, false, jsonKeys, options)
+  end
+
+  end # ~UsageSummary
+end # ~ChargeBee
diff --git a/lib/chargebee/result.rb b/lib/chargebee/result.rb
@@ -563,6 +563,16 @@ def webhook_endpoint()
         return webhook_endpoint;
     end
 
+    def usage_summary() 
+        usage_summary = get(:usage_summary, UsageSummary);
+        return usage_summary;
+    end
+
+    def usage_charge() 
+        usage_charge = get(:usage_charge, UsageCharge);
+        return usage_charge;
+    end
+
     def impacted_customer() 
         impacted_customer = get(:impacted_customer, ImpactedCustomer,
         {:download => ImpactedCustomer::Download});
