Releasing v3.19.0 (#120)

cb-alish · web-flow · commit 0ef1537ff8d0 · 2026-03-02T15:19:51.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,32 @@
+### v3.19.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.18.1 (2026-02-19)
 * * * 
 
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.18.2
+3.19.0
diff --git a/chargebee/main.py b/chargebee/main.py
@@ -143,8 +143,10 @@ def __init__(
         self.Transaction = chargebee.Transaction(self.env)
         self.UnbilledCharge = chargebee.UnbilledCharge(self.env)
         self.Usage = chargebee.Usage(self.env)
+        self.UsageCharge = chargebee.UsageCharge(self.env)
         self.UsageEvent = chargebee.UsageEvent(self.env)
         self.UsageFile = chargebee.UsageFile(self.env)
+        self.UsageSummary = chargebee.UsageSummary(self.env)
         self.VirtualBankAccount = chargebee.VirtualBankAccount(self.env)
         self.WebhookEndpoint = chargebee.WebhookEndpoint(self.env)
 
diff --git a/chargebee/models/__init__.py b/chargebee/models/__init__.py
@@ -86,6 +86,7 @@
     UsageAccumulationResetFrequency,
     ValidationStatus,
     VoucherType,
+    WindowSize,
     ChargeOn,
 )
 
@@ -297,10 +298,14 @@
 
 from chargebee.models.usage.operations import Usage
 
+from chargebee.models.usage_charge.operations import UsageCharge
+
 from chargebee.models.usage_event.operations import UsageEvent
 
 from chargebee.models.usage_file.operations import UsageFile
 
+from chargebee.models.usage_summary.operations import UsageSummary
+
 from chargebee.models.virtual_bank_account.operations import VirtualBankAccount
 
 from chargebee.models.webhook_endpoint.operations import WebhookEndpoint
diff --git a/chargebee/models/enums.py b/chargebee/models/enums.py
@@ -1277,3 +1277,14 @@ class VoucherType(Enum):
 
     def __str__(self):
         return self.value
+
+
+class WindowSize(Enum):
+    MONTH = "month"
+    WEEK = "week"
+    DAY = "day"
+    HOUR = "hour"
+    MINUTE = "minute"
+
+    def __str__(self):
+        return self.value
diff --git a/chargebee/models/invoice/operations.py b/chargebee/models/invoice/operations.py
@@ -939,6 +939,7 @@ class CreateForChargeItemsAndChargesParams(TypedDict):
         authorization_transaction_id: NotRequired[str]
         payment_source_id: NotRequired[str]
         auto_collection: NotRequired[enums.AutoCollection]
+        net_term_days: NotRequired[int]
         tax_providers_fields: NotRequired[
             List["Invoice.CreateForChargeItemsAndChargesTaxProvidersFieldParams"]
         ]
diff --git a/chargebee/models/pricing_page_session/operations.py b/chargebee/models/pricing_page_session/operations.py
@@ -1,7 +1,7 @@
 from .responses import *
 from chargebee import request, environment
 from typing import TypedDict, Required, NotRequired, Dict, List, Any, cast
-from chargebee.models import enums
+from chargebee.models import enums, contract_term
 
 
 @dataclass
@@ -67,6 +67,10 @@ class CreateForNewSubscriptionShippingAddressParams(TypedDict):
         country: NotRequired[str]
         validation_status: NotRequired[enums.ValidationStatus]
 
+    class CreateForNewSubscriptionContractTermParams(TypedDict):
+        action_at_term_end: NotRequired["contract_term.ContractTerm.ActionAtTermEnd"]
+        cancellation_cutoff_period: NotRequired[int]
+
     class CreateForExistingSubscriptionPricingPageParams(TypedDict):
         id: NotRequired[str]
 
@@ -85,6 +89,10 @@ class CreateForExistingSubscriptionDiscountParams(TypedDict):
         quantity: NotRequired[int]
         label: NotRequired[str]
 
+    class CreateForExistingSubscriptionContractTermParams(TypedDict):
+        action_at_term_end: NotRequired["contract_term.ContractTerm.ActionAtTermEnd"]
+        cancellation_cutoff_period: NotRequired[int]
+
     class CreateForNewSubscriptionParams(TypedDict):
         redirect_url: NotRequired[str]
         pricing_page: Required[
@@ -108,6 +116,9 @@ class CreateForNewSubscriptionParams(TypedDict):
         shipping_address: NotRequired[
             "PricingPageSession.CreateForNewSubscriptionShippingAddressParams"
         ]
+        contract_term: NotRequired[
+            "PricingPageSession.CreateForNewSubscriptionContractTermParams"
+        ]
 
     class CreateForExistingSubscriptionParams(TypedDict):
         redirect_url: NotRequired[str]
@@ -121,6 +132,9 @@ class CreateForExistingSubscriptionParams(TypedDict):
         discounts: Required[
             List["PricingPageSession.CreateForExistingSubscriptionDiscountParams"]
         ]
+        contract_term: NotRequired[
+            "PricingPageSession.CreateForExistingSubscriptionContractTermParams"
+        ]
 
     def create_for_new_subscription(
         self, params: CreateForNewSubscriptionParams, headers=None
diff --git a/chargebee/models/pricing_page_session/responses.py b/chargebee/models/pricing_page_session/responses.py
@@ -2,6 +2,7 @@
 from chargebee.model import Model
 from typing import Dict, List, Any
 from chargebee.response import Response
+from chargebee.models import contract_term
 
 
 @dataclass
diff --git a/chargebee/models/quote/operations.py b/chargebee/models/quote/operations.py
@@ -528,6 +528,8 @@ class CreateSubItemsForCustomerQuoteSubscriptionParams(TypedDict):
         start_date: NotRequired[int]
         offline_payment_method: NotRequired[enums.OfflinePaymentMethod]
         contract_term_billing_cycle_on_renewal: NotRequired[int]
+        free_period: NotRequired[int]
+        free_period_unit: NotRequired[enums.FreePeriodUnit]
 
     class CreateSubItemsForCustomerQuoteSubscriptionItemParams(TypedDict):
         item_price_id: Required[str]
@@ -620,6 +622,8 @@ class EditCreateSubCustomerQuoteForItemsSubscriptionParams(TypedDict):
         start_date: NotRequired[int]
         offline_payment_method: NotRequired[enums.OfflinePaymentMethod]
         contract_term_billing_cycle_on_renewal: NotRequired[int]
+        free_period: NotRequired[int]
+        free_period_unit: NotRequired[enums.FreePeriodUnit]
 
     class EditCreateSubCustomerQuoteForItemsSubscriptionItemParams(TypedDict):
         item_price_id: Required[str]
diff --git a/chargebee/models/quoted_subscription/operations.py b/chargebee/models/quoted_subscription/operations.py
@@ -9,14 +9,6 @@
 class QuotedSubscription:
     env: environment.Environment
 
-    class ChangeOption(Enum):
-        END_OF_TERM = "end_of_term"
-        SPECIFIC_DATE = "specific_date"
-        IMMEDIATELY = "immediately"
-
-        def __str__(self):
-            return self.value
-
     class BillingPeriodUnit(Enum):
         DAY = "day"
         WEEK = "week"
@@ -26,6 +18,14 @@ class BillingPeriodUnit(Enum):
         def __str__(self):
             return self.value
 
+    class ChangeOption(Enum):
+        END_OF_TERM = "end_of_term"
+        SPECIFIC_DATE = "specific_date"
+        IMMEDIATELY = "immediately"
+
+        def __str__(self):
+            return self.value
+
     class QuotedContractTermActionAtTermEnd(Enum):
         RENEW = "renew"
         EVERGREEN = "evergreen"
diff --git a/chargebee/models/quoted_subscription/responses.py b/chargebee/models/quoted_subscription/responses.py
@@ -112,6 +112,8 @@ class QuotedSubscriptionResponse(Model):
     plan_unit_price_in_decimal: str = None
     changes_scheduled_at: int = None
     change_option: str = None
+    free_period: int = None
+    free_period_unit: str = None
     contract_term_billing_cycle_on_renewal: int = None
     addons: List[AddonResponse] = None
     event_based_addons: List[EventBasedAddonResponse] = None
diff --git a/chargebee/models/subscription/operations.py b/chargebee/models/subscription/operations.py
@@ -10,6 +10,15 @@
 class Subscription:
     env: environment.Environment
 
+    class BillingPeriodUnit(Enum):
+        DAY = "day"
+        WEEK = "week"
+        MONTH = "month"
+        YEAR = "year"
+
+        def __str__(self):
+            return self.value
+
     class Status(Enum):
         FUTURE = "future"
         IN_TRIAL = "in_trial"
@@ -34,15 +43,6 @@ class CancelReason(Enum):
         def __str__(self):
             return self.value
 
-    class BillingPeriodUnit(Enum):
-        DAY = "day"
-        WEEK = "week"
-        MONTH = "month"
-        YEAR = "year"
-
-        def __str__(self):
-            return self.value
-
     class ReferralInfoRewardStatus(Enum):
         PENDING = "pending"
         PAID = "paid"
@@ -198,18 +198,6 @@ class Discount(TypedDict):
         coupon_id: Required[str]
         index: Required[int]
 
-    class Addon(TypedDict):
-        id: Required[str]
-        quantity: NotRequired[int]
-        unit_price: NotRequired[int]
-        amount: NotRequired[int]
-        trial_end: NotRequired[int]
-        remaining_billing_cycles: NotRequired[int]
-        quantity_in_decimal: NotRequired[str]
-        unit_price_in_decimal: NotRequired[str]
-        amount_in_decimal: NotRequired[str]
-        proration_type: NotRequired[enums.ProrationType]
-
     class ChargedEventBasedAddon(TypedDict):
         id: Required[str]
         last_charged_at: Required[int]
@@ -224,6 +212,18 @@ class EventBasedAddon(TypedDict):
         quantity_in_decimal: NotRequired[str]
         unit_price_in_decimal: NotRequired[str]
 
+    class Addon(TypedDict):
+        id: Required[str]
+        quantity: NotRequired[int]
+        unit_price: NotRequired[int]
+        amount: NotRequired[int]
+        trial_end: NotRequired[int]
+        remaining_billing_cycles: NotRequired[int]
+        quantity_in_decimal: NotRequired[str]
+        unit_price_in_decimal: NotRequired[str]
+        amount_in_decimal: NotRequired[str]
+        proration_type: NotRequired[enums.ProrationType]
+
     class CreateCustomerParams(TypedDict):
         id: NotRequired[str]
         email: NotRequired[str]
diff --git a/chargebee/models/subscription/responses.py b/chargebee/models/subscription/responses.py
@@ -166,21 +166,6 @@ class DiscountResponse(Model):
     index: int = None
 
 
-@dataclass
-class AddonResponse(Model):
-    raw_data: Dict[Any, Any] = None
-    id: str = None
-    quantity: int = None
-    unit_price: int = None
-    amount: int = None
-    trial_end: int = None
-    remaining_billing_cycles: int = None
-    quantity_in_decimal: str = None
-    unit_price_in_decimal: str = None
-    amount_in_decimal: str = None
-    proration_type: str = None
-
-
 @dataclass
 class ChargedEventBasedAddonResponse(Model):
     raw_data: Dict[Any, Any] = None
@@ -201,6 +186,21 @@ class EventBasedAddonResponse(Model):
     unit_price_in_decimal: str = None
 
 
+@dataclass
+class AddonResponse(Model):
+    raw_data: Dict[Any, Any] = None
+    id: str = None
+    quantity: int = None
+    unit_price: int = None
+    amount: int = None
+    trial_end: int = None
+    remaining_billing_cycles: int = None
+    quantity_in_decimal: str = None
+    unit_price_in_decimal: str = None
+    amount_in_decimal: str = None
+    proration_type: str = None
+
+
 @dataclass
 class SubscriptionResponse(Model):
     raw_data: Dict[Any, Any] = None
diff --git a/chargebee/models/usage_charge/__init__.py b/chargebee/models/usage_charge/__init__.py
@@ -0,0 +1,2 @@
+from .operations import UsageCharge
+from .responses import UsageChargeResponse
diff --git a/chargebee/models/usage_charge/operations.py b/chargebee/models/usage_charge/operations.py
@@ -0,0 +1,32 @@
+from .responses import *
+from chargebee import request, environment
+from typing import TypedDict, Required, NotRequired, Dict, List, Any, cast
+from chargebee.filters import Filters
+
+
+@dataclass
+class UsageCharge:
+    env: environment.Environment
+
+    class RetrieveUsageChargesForSubscriptionParams(TypedDict):
+        limit: NotRequired[int]
+        offset: NotRequired[str]
+        feature_id: NotRequired[Filters.StringFilter]
+
+    def retrieve_usage_charges_for_subscription(
+        self, id, params: RetrieveUsageChargesForSubscriptionParams = None, headers=None
+    ) -> RetrieveUsageChargesForSubscriptionResponse:
+        jsonKeys = {}
+        options = {}
+        return request.send(
+            "get",
+            request.uri_path("subscriptions", id, "usage_charges"),
+            self.env,
+            cast(Dict[Any, Any], params),
+            headers,
+            RetrieveUsageChargesForSubscriptionResponse,
+            None,
+            False,
+            jsonKeys,
+            options,
+        )
diff --git a/chargebee/models/usage_charge/responses.py b/chargebee/models/usage_charge/responses.py
@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+from chargebee.model import Model
+from typing import Dict, List, Any
+from chargebee.response import Response
+
+
+@dataclass
+class UsageChargeResponse(Model):
+    raw_data: Dict[Any, Any] = None
+    subscription_id: str = None
+    feature_id: str = None
+    included_usage: str = None
+    total_usage: str = None
+    on_demand_usage: str = None
+    metered_item_price_id: str = None
+    amount: str = None
+    currency_code: str = None
+    usage_from: int = None
+    usage_to: int = None
+
+
+@dataclass
+class RetrieveUsageChargesForSubscriptionUsageChargeResponse:
+    usage_charge: UsageChargeResponse
+
+
+@dataclass
+class RetrieveUsageChargesForSubscriptionResponse(Response):
+    list: List[RetrieveUsageChargesForSubscriptionUsageChargeResponse]
+    next_offset: str = None
diff --git a/chargebee/models/usage_summary/__init__.py b/chargebee/models/usage_summary/__init__.py
@@ -0,0 +1,2 @@
+from .operations import UsageSummary
+from .responses import UsageSummaryResponse
diff --git a/chargebee/models/usage_summary/operations.py b/chargebee/models/usage_summary/operations.py
diff --git a/chargebee/models/usage_summary/responses.py b/chargebee/models/usage_summary/responses.py
diff --git a/chargebee/version.py b/chargebee/version.py

Original file line number	Diff line number	Diff line change
`@@ -939,6 +939,7 @@ class CreateForChargeItemsAndChargesParams(TypedDict):`
`939`	`939`	`authorization_transaction_id: NotRequired[str]`
`940`	`940`	`payment_source_id: NotRequired[str]`
`941`	`941`	`auto_collection: NotRequired[enums.AutoCollection]`
	`942`	`+ net_term_days: NotRequired[int]`
`942`	`943`	`tax_providers_fields: NotRequired[`
`943`	`944`	`List["Invoice.CreateForChargeItemsAndChargesTaxProvidersFieldParams"]`
`944`	`945`	`]`