Releasing v3.22.0

CHANGELOG.md

@@ -1,3 +1,12 @@
+### v3.22.0 (2026-05-07)
+* * *
+
+### Bug fixes: 
+
+- Fixed an inconsistency in required parameters for API methods between the SDK Generator and OpenAPI specifications.
+
+
+
 ### v3.21.0 (2026-05-04)
 * * *
 ### New Resources:

VERSION

@@ -1 +1 @@
-3.21.0
+3.22.0

chargebee/models/addon/operations.py

@@ -141,7 +141,7 @@ class CreateParams(TypedDict):
         show_description_in_invoices: NotRequired[bool]
         show_description_in_quotes: NotRequired[bool]
         price_in_decimal: NotRequired[str]
-        tax_providers_fields: Required[List["Addon.CreateTaxProvidersFieldParams"]]
+        tax_providers_fields: NotRequired[List["Addon.CreateTaxProvidersFieldParams"]]
         proration_type: NotRequired["Addon.ProrationType"]
         status: NotRequired["Addon.Status"]
 
@@ -182,7 +182,7 @@ class UpdateParams(TypedDict):
         show_description_in_invoices: NotRequired[bool]
         show_description_in_quotes: NotRequired[bool]
         price_in_decimal: NotRequired[str]
-        tax_providers_fields: Required[List["Addon.UpdateTaxProvidersFieldParams"]]
+        tax_providers_fields: NotRequired[List["Addon.UpdateTaxProvidersFieldParams"]]
         proration_type: NotRequired["Addon.ProrationType"]
 
     class ListParams(TypedDict):

chargebee/models/alert/operations.py

@@ -36,7 +36,7 @@ class CreateParams(TypedDict):
         description: NotRequired[str]
         metered_feature_id: Required[str]
         subscription_id: NotRequired[str]
-        threshold: Required["Alert.CreateThresholdParams"]
+        threshold: NotRequired["Alert.CreateThresholdParams"]
         meta: NotRequired[str]
         filter_conditions: NotRequired[List["Alert.CreateFilterConditionParams"]]
 

chargebee/models/coupon/operations.py

@@ -203,12 +203,12 @@ class CreateForItemsParams(TypedDict):
         included_in_mrr: NotRequired[bool]
         period: NotRequired[int]
         period_unit: NotRequired[enums.PeriodUnit]
-        item_constraints: Required[List["Coupon.CreateForItemsItemConstraintParams"]]
+        item_constraints: NotRequired[List["Coupon.CreateForItemsItemConstraintParams"]]
         item_constraint_criteria: NotRequired[
             List["Coupon.CreateForItemsItemConstraintCriteriaParams"]
         ]
         status: NotRequired["Coupon.Status"]
-        coupon_constraints: Required[
+        coupon_constraints: NotRequired[
             List["Coupon.CreateForItemsCouponConstraintParams"]
         ]
 
@@ -231,11 +231,11 @@ class UpdateForItemsParams(TypedDict):
         included_in_mrr: NotRequired[bool]
         period: NotRequired[int]
         period_unit: NotRequired[enums.PeriodUnit]
-        item_constraints: Required[List["Coupon.UpdateForItemsItemConstraintParams"]]
+        item_constraints: NotRequired[List["Coupon.UpdateForItemsItemConstraintParams"]]
         item_constraint_criteria: NotRequired[
             List["Coupon.UpdateForItemsItemConstraintCriteriaParams"]
         ]
-        coupon_constraints: Required[
+        coupon_constraints: NotRequired[
             List["Coupon.UpdateForItemsCouponConstraintParams"]
         ]
 

chargebee/models/credit_note/operations.py

@@ -407,7 +407,7 @@ class RefundParams(TypedDict):
         refund_reason_code: NotRequired[str]
 
     class RecordRefundParams(TypedDict):
-        transaction: Required["CreditNote.RecordRefundTransactionParams"]
+        transaction: NotRequired["CreditNote.RecordRefundTransactionParams"]
         refund_reason_code: NotRequired[str]
         comment: NotRequired[str]
 
@@ -446,7 +446,7 @@ class DeleteParams(TypedDict):
         comment: NotRequired[str]
 
     class RemoveTaxWithheldRefundParams(TypedDict):
-        tax_withheld: Required["CreditNote.RemoveTaxWithheldRefundTaxWithheldParams"]
+        tax_withheld: NotRequired["CreditNote.RemoveTaxWithheldRefundTaxWithheldParams"]
 
     class ImportCreditNoteParams(TypedDict):
         id: Required[str]
@@ -465,12 +465,16 @@ class ImportCreditNoteParams(TypedDict):
         round_off_amount: NotRequired[int]
         fractional_correction: NotRequired[int]
         vat_number_prefix: NotRequired[str]
-        line_items: Required[List["CreditNote.ImportCreditNoteLineItemParams"]]
-        line_item_tiers: Required[List["CreditNote.ImportCreditNoteLineItemTierParams"]]
-        discounts: Required[List["CreditNote.ImportCreditNoteDiscountParams"]]
-        taxes: Required[List["CreditNote.ImportCreditNoteTaxParams"]]
-        allocations: Required[List["CreditNote.ImportCreditNoteAllocationParams"]]
-        linked_refunds: Required[List["CreditNote.ImportCreditNoteLinkedRefundParams"]]
+        line_items: NotRequired[List["CreditNote.ImportCreditNoteLineItemParams"]]
+        line_item_tiers: NotRequired[
+            List["CreditNote.ImportCreditNoteLineItemTierParams"]
+        ]
+        discounts: NotRequired[List["CreditNote.ImportCreditNoteDiscountParams"]]
+        taxes: NotRequired[List["CreditNote.ImportCreditNoteTaxParams"]]
+        allocations: NotRequired[List["CreditNote.ImportCreditNoteAllocationParams"]]
+        linked_refunds: NotRequired[
+            List["CreditNote.ImportCreditNoteLinkedRefundParams"]
+        ]
 
     def create(self, params: CreateParams, headers=None) -> CreateResponse:
         jsonKeys = {}

chargebee/models/customer/operations.py

@@ -537,7 +537,7 @@ class UpdateParams(TypedDict):
         ]
 
     class UpdatePaymentMethodParams(TypedDict):
-        payment_method: Required["Customer.UpdatePaymentMethodPaymentMethodParams"]
+        payment_method: NotRequired["Customer.UpdatePaymentMethodPaymentMethodParams"]
 
     class UpdateBillingInfoParams(TypedDict):
         billing_address: NotRequired["Customer.UpdateBillingInfoBillingAddressParams"]
@@ -565,13 +565,13 @@ class AssignPaymentRoleParams(TypedDict):
         role: Required[enums.Role]
 
     class AddContactParams(TypedDict):
-        contact: Required["Customer.AddContactContactParams"]
+        contact: NotRequired["Customer.AddContactContactParams"]
 
     class UpdateContactParams(TypedDict):
-        contact: Required["Customer.UpdateContactContactParams"]
+        contact: NotRequired["Customer.UpdateContactContactParams"]
 
     class DeleteContactParams(TypedDict):
-        contact: Required["Customer.DeleteContactContactParams"]
+        contact: NotRequired["Customer.DeleteContactContactParams"]
 
     class AddPromotionalCreditsParams(TypedDict):
         amount: Required[int]
@@ -595,12 +595,12 @@ class SetPromotionalCreditsParams(TypedDict):
         reference: NotRequired[str]
 
     class RecordExcessPaymentParams(TypedDict):
-        transaction: Required["Customer.RecordExcessPaymentTransactionParams"]
+        transaction: NotRequired["Customer.RecordExcessPaymentTransactionParams"]
         comment: NotRequired[str]
 
     class CollectPaymentParams(TypedDict):
         amount: NotRequired[int]
-        invoice_allocations: Required[
+        invoice_allocations: NotRequired[
             List["Customer.CollectPaymentInvoiceAllocationParams"]
         ]
         payment_source_id: NotRequired[str]

chargebee/models/differential_price/operations.py

@@ -72,7 +72,7 @@ class CreateParams(TypedDict):
         parent_item_id: Required[str]
         price: NotRequired[int]
         price_in_decimal: NotRequired[str]
-        parent_periods: Required[List["DifferentialPrice.CreateParentPeriodParams"]]
+        parent_periods: NotRequired[List["DifferentialPrice.CreateParentPeriodParams"]]
         tiers: NotRequired[List["DifferentialPrice.CreateTierParams"]]
         business_entity_id: NotRequired[str]
 
@@ -83,7 +83,7 @@ class UpdateParams(TypedDict):
         item_price_id: Required[str]
         price: NotRequired[int]
         price_in_decimal: NotRequired[str]
-        parent_periods: Required[List["DifferentialPrice.UpdateParentPeriodParams"]]
+        parent_periods: NotRequired[List["DifferentialPrice.UpdateParentPeriodParams"]]
         tiers: NotRequired[List["DifferentialPrice.UpdateTierParams"]]
 
     class DeleteParams(TypedDict):

chargebee/models/entitlement/operations.py

@@ -39,7 +39,7 @@ class ListParams(TypedDict):
     class CreateParams(TypedDict):
         action: Required[enums.Action]
         change_reason: NotRequired[str]
-        entitlements: Required[List["Entitlement.CreateEntitlementParams"]]
+        entitlements: NotRequired[List["Entitlement.CreateEntitlementParams"]]
 
     def list(self, params: ListParams = None, headers=None) -> ListResponse:
         jsonKeys = {}

chargebee/models/entitlement_override/operations.py

@@ -28,7 +28,7 @@ class AddEntitlementOverrideForSubscriptionEntitlementOverrideParams(TypedDict):
 
     class AddEntitlementOverrideForSubscriptionParams(TypedDict):
         action: NotRequired[enums.Action]
-        entitlement_overrides: Required[
+        entitlement_overrides: NotRequired[
             List[
                 "EntitlementOverride.AddEntitlementOverrideForSubscriptionEntitlementOverrideParams"
             ]

chargebee/models/estimate/operations.py

@@ -756,7 +756,7 @@ class CreateInvoiceForItemsBillingAddressParams(TypedDict):
         validation_status: NotRequired[enums.ValidationStatus]
 
     class CreateSubscriptionParams(TypedDict):
-        subscription: Required["Estimate.CreateSubscriptionSubscriptionParams"]
+        subscription: NotRequired["Estimate.CreateSubscriptionSubscriptionParams"]
         billing_cycles: NotRequired[int]
         addons: NotRequired[List["Estimate.CreateSubscriptionAddonParams"]]
         event_based_addons: NotRequired[
@@ -782,10 +782,10 @@ class CreateSubscriptionParams(TypedDict):
     class CreateSubItemEstimateParams(TypedDict):
         subscription: NotRequired["Estimate.CreateSubItemEstimateSubscriptionParams"]
         billing_cycles: NotRequired[int]
-        subscription_items: Required[
+        subscription_items: NotRequired[
             List["Estimate.CreateSubItemEstimateSubscriptionItemParams"]
         ]
-        discounts: Required[List["Estimate.CreateSubItemEstimateDiscountParams"]]
+        discounts: NotRequired[List["Estimate.CreateSubItemEstimateDiscountParams"]]
         mandatory_items_to_remove: NotRequired[List[str]]
         item_tiers: NotRequired[List["Estimate.CreateSubItemEstimateItemTierParams"]]
         terms_to_charge: NotRequired[int]
@@ -836,10 +836,10 @@ class CreateSubItemForCustomerEstimateParams(TypedDict):
         ]
         invoice_immediately: NotRequired[bool]
         billing_cycles: NotRequired[int]
-        subscription_items: Required[
+        subscription_items: NotRequired[
             List["Estimate.CreateSubItemForCustomerEstimateSubscriptionItemParams"]
         ]
-        discounts: Required[
+        discounts: NotRequired[
             List["Estimate.CreateSubItemForCustomerEstimateDiscountParams"]
         ]
         mandatory_items_to_remove: NotRequired[List[str]]
@@ -864,7 +864,7 @@ class CreateSubItemForCustomerEstimateParams(TypedDict):
         ]
 
     class UpdateSubscriptionParams(TypedDict):
-        subscription: Required["Estimate.UpdateSubscriptionSubscriptionParams"]
+        subscription: NotRequired["Estimate.UpdateSubscriptionSubscriptionParams"]
         changes_scheduled_at: NotRequired[int]
         change_option: NotRequired[enums.ChangeOption]
         addons: NotRequired[List["Estimate.UpdateSubscriptionAddonParams"]]
@@ -894,15 +894,19 @@ class UpdateSubscriptionParams(TypedDict):
         invoice_immediately: NotRequired[bool]
 
     class UpdateSubscriptionForItemsParams(TypedDict):
-        subscription: Required["Estimate.UpdateSubscriptionForItemsSubscriptionParams"]
+        subscription: NotRequired[
+            "Estimate.UpdateSubscriptionForItemsSubscriptionParams"
+        ]
         changes_scheduled_at: NotRequired[int]
         change_option: NotRequired[enums.ChangeOption]
-        subscription_items: Required[
+        subscription_items: NotRequired[
             List["Estimate.UpdateSubscriptionForItemsSubscriptionItemParams"]
         ]
         mandatory_items_to_remove: NotRequired[List[str]]
         replace_items_list: NotRequired[bool]
-        discounts: Required[List["Estimate.UpdateSubscriptionForItemsDiscountParams"]]
+        discounts: NotRequired[
+            List["Estimate.UpdateSubscriptionForItemsDiscountParams"]
+        ]
         item_tiers: NotRequired[
             List["Estimate.UpdateSubscriptionForItemsItemTierParams"]
         ]
@@ -1010,18 +1014,20 @@ class ResumeSubscriptionParams(TypedDict):
 
     class GiftSubscriptionParams(TypedDict):
         gift: NotRequired["Estimate.GiftSubscriptionGiftParams"]
-        gifter: Required["Estimate.GiftSubscriptionGifterParams"]
-        gift_receiver: Required["Estimate.GiftSubscriptionGiftReceiverParams"]
+        gifter: NotRequired["Estimate.GiftSubscriptionGifterParams"]
+        gift_receiver: NotRequired["Estimate.GiftSubscriptionGiftReceiverParams"]
         coupon_ids: NotRequired[List[str]]
         payment_intent: NotRequired["Estimate.GiftSubscriptionPaymentIntentParams"]
         shipping_address: NotRequired["Estimate.GiftSubscriptionShippingAddressParams"]
-        subscription: Required["Estimate.GiftSubscriptionSubscriptionParams"]
+        subscription: NotRequired["Estimate.GiftSubscriptionSubscriptionParams"]
         addons: NotRequired[List["Estimate.GiftSubscriptionAddonParams"]]
 
     class GiftSubscriptionForItemsParams(TypedDict):
         gift: NotRequired["Estimate.GiftSubscriptionForItemsGiftParams"]
-        gifter: Required["Estimate.GiftSubscriptionForItemsGifterParams"]
-        gift_receiver: Required["Estimate.GiftSubscriptionForItemsGiftReceiverParams"]
+        gifter: NotRequired["Estimate.GiftSubscriptionForItemsGifterParams"]
+        gift_receiver: NotRequired[
+            "Estimate.GiftSubscriptionForItemsGiftReceiverParams"
+        ]
         coupon_ids: NotRequired[List[str]]
         payment_intent: NotRequired[
             "Estimate.GiftSubscriptionForItemsPaymentIntentParams"
@@ -1069,7 +1075,7 @@ class CreateInvoiceForItemsParams(TypedDict):
         authorization_transaction_id: NotRequired[str]
         payment_source_id: NotRequired[str]
         auto_collection: NotRequired[enums.AutoCollection]
-        discounts: Required[List["Estimate.CreateInvoiceForItemsDiscountParams"]]
+        discounts: NotRequired[List["Estimate.CreateInvoiceForItemsDiscountParams"]]
         shipping_address: NotRequired[
             "Estimate.CreateInvoiceForItemsShippingAddressParams"
         ]

chargebee/models/gift/operations.py

@@ -153,21 +153,21 @@ class CreateParams(TypedDict):
         auto_claim: NotRequired[bool]
         no_expiry: NotRequired[bool]
         claim_expiry_date: NotRequired[int]
-        gifter: Required["Gift.CreateGifterParams"]
-        gift_receiver: Required["Gift.CreateGiftReceiverParams"]
+        gifter: NotRequired["Gift.CreateGifterParams"]
+        gift_receiver: NotRequired["Gift.CreateGiftReceiverParams"]
         coupon_ids: NotRequired[List[str]]
         payment_intent: NotRequired["Gift.CreatePaymentIntentParams"]
         shipping_address: NotRequired["Gift.CreateShippingAddressParams"]
-        subscription: Required["Gift.CreateSubscriptionParams"]
+        subscription: NotRequired["Gift.CreateSubscriptionParams"]
         addons: NotRequired[List["Gift.CreateAddonParams"]]
 
     class CreateForItemsParams(TypedDict):
         scheduled_at: NotRequired[int]
         auto_claim: NotRequired[bool]
         no_expiry: NotRequired[bool]
         claim_expiry_date: NotRequired[int]
-        gifter: Required["Gift.CreateForItemsGifterParams"]
-        gift_receiver: Required["Gift.CreateForItemsGiftReceiverParams"]
+        gifter: NotRequired["Gift.CreateForItemsGifterParams"]
+        gift_receiver: NotRequired["Gift.CreateForItemsGiftReceiverParams"]
         coupon_ids: NotRequired[List[str]]
         payment_intent: NotRequired["Gift.CreateForItemsPaymentIntentParams"]
         shipping_address: NotRequired["Gift.CreateForItemsShippingAddressParams"]