{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Python client library 3.18.0 changelog","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"python-client-library-3180-changelog","__idx":0},"children":["Python client library 3.18.0 changelog"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"__init__","__idx":1},"children":["__init__"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfig"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigAttributesInner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigAttributesInnerMapping"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigRateCardsInner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigRateCardsInnerConditionsInner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigRateCardsInnerPricing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: ExpandedChildCommitment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: QueryChildCommitmentsResponse"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: WriteOffInvoiceAsyncJobResponse"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"credit_memos_api","__idx":2},"children":["credit_memos_api"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction_id"]}," to the CreditMemosApi class. This field is used for specifying a service-provider transaction ID for Re-Sync operations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"debit_memos_api","__idx":3},"children":["debit_memos_api"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction_id"]}," to the DebitMemosApi class. This field is used for specifying a service-provider transaction ID for Re-Sync operations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"invoices_api","__idx":4},"children":["invoices_api"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method get_invoice_write_off_async_job to retrieve information about a specific asynchronous invoice write-off job."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method get_invoice_write_off_async_job_with_http_info to retrieve information about a specific asynchronous invoice write-off job with HTTP info."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method create_invoice_write_off_async to write off an invoice asynchronously."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method create_invoice_write_off_async_with_http_info to write off an invoice asynchronously with HTTP info."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction_id"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["post_invoice"]}," method for optional service-provider transaction ID in Re-Sync operations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"object_queries_api","__idx":5},"children":["object_queries_api"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.expanded_child_commitment import ExpandedChildCommitment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.query_child_commitments_response import QueryChildCommitmentsResponse"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method: query_child_commitment_by_key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method: query_child_commitment_by_key_with_http_info"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method: query_child_commitments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new method: query_child_commitments_with_http_info"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"models__init__","__idx":6},"children":["models/__init__"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfig"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigAttributesInner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigAttributesInnerMapping"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigRateCardsInner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigRateCardsInnerConditionsInner"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: CustomAmountConfigRateCardsInnerPricing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: ExpandedChildCommitment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: QueryChildCommitmentsResponse"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new class: WriteOffInvoiceAsyncJobResponse"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base_period","__idx":7},"children":["base_period"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balance"]}," to the BasePeriod class."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true_up_amount"]}," to the BasePeriod class with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trueUpAmount"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired_amount"]}," to the BasePeriod class with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiredAmount"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billed_total_spending"]}," to the BasePeriod class with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billedTotalSpending"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"charge_override","__idx":8},"children":["charge_override"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prepayment_unit_type"]}," with validation for enum values (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNIT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CURRENCY"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_scope"]}," with validation for enum values (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RATEPLAN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUBSCRIPTION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_anchor_date"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clearing_existing_rollover_period_type"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clearing_existing_rollover_period_length"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitment_schedule_attributes","__idx":9},"children":["commitment_schedule_attributes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," field has been changed to always be required, which is a change in nullability/optionality."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new import for CustomAmountConfig."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type CustomAmountConfig to the CommitmentScheduleAttributes class."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list to include the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Modified the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to_dict"]}," method to include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," if it is present."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Modified the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from_dict"]}," method to handle the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," field."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitment_schedule_input","__idx":10},"children":["commitment_schedule_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," description changed to indicate it is always required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from zuora_sdk.models.custom_amount_config import CustomAmountConfig"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type Optional[CustomAmountConfig] to the class CommitmentScheduleInput."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list to include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to_dict"]}," method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from_dict"]}," method."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitment_schedule_output","__idx":11},"children":["commitment_schedule_output"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," field's description changed to indicate it is always required, which implies a change from optional to required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new import: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from zuora_sdk.models.custom_amount_config import CustomAmountConfig"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type CustomAmountConfig to the CommitmentScheduleOutput class."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list to include the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to_dict"]}," method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from_dict"]}," method."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create_billing_preview_run_request","__idx":12},"children":["create_billing_preview_run_request"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organization_labels"]}," of type Optional[List[OrganizationLabel]] to the CreateBillingPreviewRunRequest class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create_invoice_item","__idx":13},"children":["create_invoice_item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accounts_receivable_accounting_code"]}," to the CreateInvoiceItem class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create_invoice_request","__idx":14},"children":["create_invoice_request"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}," of type StrictStr to the CreateInvoiceRequest model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create_product_rate_plan_charge_request","__idx":15},"children":["create_product_rate_plan_charge_request"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.commitment_level import CommitmentLevel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.rollover_end_date_type import RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.rollover_period_type import RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.vp_alignment import VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.vp_proration_option import VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitment_level"]},": Optional[CommitmentLevel] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentLevel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]},": Optional[StrictInt] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DrawdownPriority"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]},": Optional[VpAlignment] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VpAlignment"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]},": Optional[VpProrationOption] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VpProrationOption"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]},": Optional[StrictInt] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SpecificValidityPeriodLength"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]},": Optional[RolloverPeriodType] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RolloverPeriodType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]},": Optional[StrictInt] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RolloverFundPriority"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]},": Optional[RolloverEndDateType] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RolloverEndDateType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]},": Optional[StrictBool] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FundSupportAccountHierarchy"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create_sequence_set_request","__idx":16},"children":["create_sequence_set_request"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sequence_set_number"]}," with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sequenceSetNumber"]}," to the CreateSequenceSetRequest class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"credit_memo_item_from_write_off_invoice","__idx":17},"children":["credit_memo_item_from_write_off_invoice"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exclude_item_billing_from_revenue_accounting"]}," of type Optional[StrictBool] to the CreditMemoItemFromWriteOffInvoice class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_account","__idx":18},"children":["expanded_account"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integration_id__ns"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_commitment","__idx":19},"children":["expanded_commitment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overlap_drawdown_policy"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["child_commitments"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_commitment_associated_item","__idx":20},"children":["expanded_commitment_associated_item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," to the ExpandedCommitmentAssociatedItem class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_commitment_period","__idx":21},"children":["expanded_commitment_period"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired_amount"]}," of type Optional[Union[StrictFloat, StrictInt]] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiredAmount"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true_up_amount"]}," of type Optional[Union[StrictFloat, StrictInt]] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trueUpAmount"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balance"]}," of type Optional[Union[StrictFloat, StrictInt]]."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_commitment_schedule","__idx":22},"children":["expanded_commitment_schedule"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type StrictStr to the ExpandedCommitmentSchedule model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_commitment_transaction","__idx":23},"children":["expanded_commitment_transaction"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," to the ExpandedCommitmentTransaction model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_invoice","__idx":24},"children":["expanded_invoice"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integration_id__ns"]}," from the ExpandedInvoice class."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integrationId__NS"]}," from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list in the ExpandedInvoice class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_payment","__idx":25},"children":["expanded_payment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integration_id__ns"]}," from the ExpandedPayment model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integrationId__NS"]}," from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list in the ExpandedPayment model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_rate_plan_charge","__idx":26},"children":["expanded_rate_plan_charge"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_entitled_quantity"]}," of type Optional[Union[StrictFloat, StrictInt]] to the ExpandedRatePlanCharge class."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_contract_value"]}," of type Optional[Union[StrictFloat, StrictInt]] to the ExpandedRatePlanCharge class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get_charge_override","__idx":27},"children":["get_charge_override"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_scope"]}," of type Optional[StrictStr] with a description and alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdownScope"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prepayment_unit_type"]}," of type Optional[StrictStr] with a description and alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prepaymentUnitType"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added field validator ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_scope_validate_enum"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_scope"]}," to validate against enum values (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RATEPLAN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUBSCRIPTION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added field validator ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prepayment_unit_type_validate_enum"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prepayment_unit_type"]}," to validate against enum values (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNIT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CURRENCY"]},")."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get_product_rate_plan_charge_response","__idx":28},"children":["get_product_rate_plan_charge_response"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import for CommitmentLevel."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import for RolloverEndDateType."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import for RolloverPeriodType."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import for VpAlignment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import for VpProrationOption."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitment_level"]}," of type Optional[CommitmentLevel]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]}," of type Optional[StrictInt]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]}," of type Optional[VpAlignment]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]}," of type Optional[VpProrationOption]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]}," of type Optional[StrictInt]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]}," of type Optional[RolloverPeriodType]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]}," of type Optional[StrictInt]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]}," of type Optional[RolloverEndDateType]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]}," of type Optional[StrictBool]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentLevel"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DrawdownPriority"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VpAlignment"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VpProrationOption"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SpecificValidityPeriodLength"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RolloverPeriodType"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RolloverFundPriority"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RolloverEndDateType"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FundSupportAccountHierarchy"]}," to the list of properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get_subscription_rate_plan_charges_with_all_segments","__idx":29},"children":["get_subscription_rate_plan_charges_with_all_segments"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_entitled_quantity"]}," of type Optional[StrictStr] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalEntitledQuantity"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_contract_value"]}," of type Optional[StrictStr] with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalContractValue"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"invoice_settlement_async_job_operation_type","__idx":30},"children":["invoice_settlement_async_job_operation_type"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New enum value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASYNCINVOICEWRITEOFF"]}," added to the InvoiceSettlementAsyncJobOperationType."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"invoice_settlement_async_job_reference_type","__idx":31},"children":["invoice_settlement_async_job_reference_type"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New enum value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE"]}," added to InvoiceSettlementAsyncJobReferenceType."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"linkage_linkage_type","__idx":32},"children":["linkage_linkage_type"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New enum value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FOR_EACH"]}," added to LinkageLinkageType."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list_commitment_period_output","__idx":33},"children":["list_commitment_period_output"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balance"]}," of type Optional[Union[StrictFloat, StrictInt]] with description ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Remaining balance for this period ("]},"committedAmount",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]},"billedTotalSpending",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]},"trueUpAmount",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]},"expiredAmount",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["). Balance is always non-negative. If the balance is 0, either "]},"billedTotalSpending",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exceeded the"]},"committedAmount",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" or the period has been evaluated"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true_up_amount"]}," of type Optional[Union[StrictFloat, StrictInt]] with description ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Total true-up amount for this commitment period. It will be null if it is a prepaid commitment or if it is not evaluated yet. This will be a non negative number."]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired_amount"]}," of type Optional[Union[StrictFloat, StrictInt]] with description ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Total expired amount for this commitment period. It will be null if it is a postpaid commitment or if the period is not evaluated yet. This will be a non negative number."]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billed_total_spending"]}," of type Optional[Union[StrictFloat, StrictInt]] with description ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sum of drawdown or drawdown reversal transactions."]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list_commitment_schedule_output","__idx":34},"children":["list_commitment_schedule_output"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," to the ListCommitmentScheduleOutput class with alias ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"override_discount_apply_detail","__idx":35},"children":["override_discount_apply_detail"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["product_rate_plan_id"]}," changed from required to optional."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["product_rate_plan_charge_id"]}," changed from required to optional."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["product_rate_plan_number"]}," added."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["product_rate_plan_charge_number"]}," added."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"period_balance","__idx":36},"children":["period_balance"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true_up_amount"]}," to the PeriodBalance model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired_amount"]}," to the PeriodBalance model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billed_total_spending"]}," to the PeriodBalance model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"preview_order_charge_override","__idx":37},"children":["preview_order_charge_override"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]}," to the PreviewOrderChargeOverride class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"product_rate_plan_charge","__idx":38},"children":["product_rate_plan_charge"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.commitment_level import CommitmentLevel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.rollover_end_date_type import RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.rollover_period_type import RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.vp_alignment import VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: from zuora_sdk.models.vp_proration_option import VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitment_level"]}," (Optional[CommitmentLevel]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]}," (Optional[StrictInt]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]}," (Optional[VpAlignment]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]}," (Optional[VpProrationOption]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]}," (Optional[StrictInt]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]}," (Optional[RolloverPeriodType]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]}," (Optional[StrictInt]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]}," (Optional[RolloverEndDateType]) to ProductRatePlanCharge"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]}," (Optional[StrictBool]) to ProductRatePlanCharge"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rate_plan_charge_segment","__idx":39},"children":["rate_plan_charge_segment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_entitled_quantity"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_contract_value"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_anchor_date"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rate_plan_charge_segment_info","__idx":40},"children":["rate_plan_charge_segment_info"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_entitled_quantity"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_contract_value"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_anchor_date"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update_discount_invoice_item","__idx":41},"children":["update_discount_invoice_item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accounts_receivable_accounting_code"]}," to the UpdateDiscountInvoiceItem class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update_invoice_item","__idx":42},"children":["update_invoice_item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accounts_receivable_accounting_code"]}," to the UpdateInvoiceItem class."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update_product_rate_plan_charge_request","__idx":43},"children":["update_product_rate_plan_charge_request"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: CommitmentLevel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: RolloverEndDateType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: RolloverPeriodType"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: VpAlignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new import: VpProrationOption"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitment_level"]}," (Optional[CommitmentLevel])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawdown_priority"]}," (Optional[StrictInt])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_alignment"]}," (Optional[VpAlignment])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vp_proration_option"]}," (Optional[VpProrationOption])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_validity_period_length"]}," (Optional[StrictInt])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_period_type"]}," (Optional[RolloverPeriodType])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_fund_priority"]}," (Optional[StrictInt])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rollover_end_date_type"]}," (Optional[RolloverEndDateType])"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund_support_account_hierarchy"]}," (Optional[StrictBool])"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert_create_commitment_input_all_of_schedules","__idx":44},"children":["upsert_create_commitment_input_all_of_schedules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," field has changed from optional to required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new import for CustomAmountConfig."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type CustomAmountConfig."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list to include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to_dict"]}," method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from_dict"]}," method."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert_create_commitment_schedule_input","__idx":45},"children":["upsert_create_commitment_schedule_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," field`s description was changed to indicate it is always required, which implies a change from optional to required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new import: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from zuora_sdk.models.custom_amount_config import CustomAmountConfig"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new optional field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type CustomAmountConfig to the UpsertCreateCommitmentScheduleInput class."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updated the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__properties"]}," list to include the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to_dict"]}," method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added logic to handle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customAmount"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from_dict"]}," method."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert_update_commitment_input","__idx":46},"children":["upsert_update_commitment_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The description for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedules"]}," field has been updated to include the ability to add new commitment schedules using \"action: create\" and to update existing ones using \"action: update\"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert_update_commitment_schedule_input","__idx":47},"children":["upsert_update_commitment_schedule_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["period_type"]}," of type Optional[PeriodTypeEnum] with default value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PeriodTypeEnum.MONTH"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_period_length"]}," of type Optional[StrictInt]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start_date"]}," of type Optional[date]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end_date"]}," of type Optional[date]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_amount"]}," of type Optional[CustomAmountConfig]."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clear_custom_amount"]}," of type Optional[StrictBool]."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validity_period_type","__idx":48},"children":["validity_period_type"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New enum value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SPECIFIC_DAYS"]}," added to ValidityPeriodType."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New enum value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SPECIFIC_WEEKS"]}," added to ValidityPeriodType."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New enum value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SPECIFIC_MONTHS"]}," added to ValidityPeriodType."]}]}]},"headings":[{"value":"Python client library 3.18.0 changelog","id":"python-client-library-3180-changelog","depth":1},{"value":"__init__","id":"__init__","depth":2},{"value":"credit_memos_api","id":"credit_memos_api","depth":2},{"value":"debit_memos_api","id":"debit_memos_api","depth":2},{"value":"invoices_api","id":"invoices_api","depth":2},{"value":"object_queries_api","id":"object_queries_api","depth":2},{"value":"models/__init__","id":"models__init__","depth":2},{"value":"base_period","id":"base_period","depth":2},{"value":"charge_override","id":"charge_override","depth":2},{"value":"commitment_schedule_attributes","id":"commitment_schedule_attributes","depth":2},{"value":"commitment_schedule_input","id":"commitment_schedule_input","depth":2},{"value":"commitment_schedule_output","id":"commitment_schedule_output","depth":2},{"value":"create_billing_preview_run_request","id":"create_billing_preview_run_request","depth":2},{"value":"create_invoice_item","id":"create_invoice_item","depth":2},{"value":"create_invoice_request","id":"create_invoice_request","depth":2},{"value":"create_product_rate_plan_charge_request","id":"create_product_rate_plan_charge_request","depth":2},{"value":"create_sequence_set_request","id":"create_sequence_set_request","depth":2},{"value":"credit_memo_item_from_write_off_invoice","id":"credit_memo_item_from_write_off_invoice","depth":2},{"value":"expanded_account","id":"expanded_account","depth":2},{"value":"expanded_commitment","id":"expanded_commitment","depth":2},{"value":"expanded_commitment_associated_item","id":"expanded_commitment_associated_item","depth":2},{"value":"expanded_commitment_period","id":"expanded_commitment_period","depth":2},{"value":"expanded_commitment_schedule","id":"expanded_commitment_schedule","depth":2},{"value":"expanded_commitment_transaction","id":"expanded_commitment_transaction","depth":2},{"value":"expanded_invoice","id":"expanded_invoice","depth":2},{"value":"expanded_payment","id":"expanded_payment","depth":2},{"value":"expanded_rate_plan_charge","id":"expanded_rate_plan_charge","depth":2},{"value":"get_charge_override","id":"get_charge_override","depth":2},{"value":"get_product_rate_plan_charge_response","id":"get_product_rate_plan_charge_response","depth":2},{"value":"get_subscription_rate_plan_charges_with_all_segments","id":"get_subscription_rate_plan_charges_with_all_segments","depth":2},{"value":"invoice_settlement_async_job_operation_type","id":"invoice_settlement_async_job_operation_type","depth":2},{"value":"invoice_settlement_async_job_reference_type","id":"invoice_settlement_async_job_reference_type","depth":2},{"value":"linkage_linkage_type","id":"linkage_linkage_type","depth":2},{"value":"list_commitment_period_output","id":"list_commitment_period_output","depth":2},{"value":"list_commitment_schedule_output","id":"list_commitment_schedule_output","depth":2},{"value":"override_discount_apply_detail","id":"override_discount_apply_detail","depth":2},{"value":"period_balance","id":"period_balance","depth":2},{"value":"preview_order_charge_override","id":"preview_order_charge_override","depth":2},{"value":"product_rate_plan_charge","id":"product_rate_plan_charge","depth":2},{"value":"rate_plan_charge_segment","id":"rate_plan_charge_segment","depth":2},{"value":"rate_plan_charge_segment_info","id":"rate_plan_charge_segment_info","depth":2},{"value":"update_discount_invoice_item","id":"update_discount_invoice_item","depth":2},{"value":"update_invoice_item","id":"update_invoice_item","depth":2},{"value":"update_product_rate_plan_charge_request","id":"update_product_rate_plan_charge_request","depth":2},{"value":"upsert_create_commitment_input_all_of_schedules","id":"upsert_create_commitment_input_all_of_schedules","depth":2},{"value":"upsert_create_commitment_schedule_input","id":"upsert_create_commitment_schedule_input","depth":2},{"value":"upsert_update_commitment_input","id":"upsert_update_commitment_input","depth":2},{"value":"upsert_update_commitment_schedule_input","id":"upsert_update_commitment_schedule_input","depth":2},{"value":"validity_period_type","id":"validity_period_type","depth":2}],"frontmatter":{"markdown":{"toc":{"hide":false}},"seo":{"title":"Python client library 3.18.0 changelog"}},"lastModified":"2026-06-11T04:08:02.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk-changelogs/python/changelog-3180","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}