{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Python client library 3.13.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-3130-changelog","__idx":0},"children":["Python client library 3.13.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 model imports: AmountBaseEnum, BaseRevenueAttributes, CommitmentOutputSchedulesInner, CommitmentScheduleAttributes, CommitmentScheduleInput, CommitmentScheduleOutput, CommitmentScheduleStatus, CommitmentScheduleStatusOutput, CommitmentStatusInput, CommitmentStatusOutput, CommonRevenueAttributesOutput, PeriodAlignmentOptionEnum, PeriodTypeEnum, UpsertCommitmentScheduleInput, UpsertCreateCommitmentInputAllOfSchedules, UpsertCreateCommitmentScheduleInput, UpsertUpdateCommitmentScheduleInput."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"object_queries_api","__idx":2},"children":["object_queries_api"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added support for expanding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceschedule"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoicescheduleitem"]}," in query methods for CreditMemoItem and InvoiceItem."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payment_methods_api","__idx":3},"children":["payment_methods_api"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added support for creating payment methods with the PayPal Complete Payments gateway integration."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"models__init__","__idx":4},"children":["models/__init__"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added AmountBaseEnum to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added BaseRevenueAttributes to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added CommitmentOutputSchedulesInner to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added CommitmentScheduleAttributes, CommitmentScheduleInput, CommitmentScheduleOutput, CommitmentScheduleStatus, CommitmentScheduleStatusOutput to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added CommitmentStatusInput and CommitmentStatusOutput to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added CommonRevenueAttributesOutput to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added PeriodAlignmentOptionEnum and PeriodTypeEnum to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added UpsertCommitmentScheduleInput to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added UpsertCreateCommitmentInputAllOfSchedules and UpsertCreateCommitmentScheduleInput to the models."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added UpsertUpdateCommitmentScheduleInput to the models."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitment_base_attributes","__idx":5},"children":["commitment_base_attributes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eligible_account_conditions"]}," field is no longer optional. It has been changed from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional[Condition]"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Condition"]},", which means it must now be provided when creating or updating a CommitmentBaseAttributes object."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitment_input","__idx":6},"children":["commitment_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eligible_account_conditions"]}," field is no longer optional and must be provided."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exclude_item_booking_from_revenue_accounting"]}," field has been removed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["period_alignment_option"]}," field of type PeriodAlignmentOptionEnum."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_period_alignment_date"]}," field of type date."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedules"]}," field which is a list of CommitmentScheduleInput."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitment_output","__idx":7},"children":["commitment_output"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_amount"]}," field to represent the total amount of the commitment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Introduced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," field to include the commitment status."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedules"]}," field to include a list of commitment schedules."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_commitment","__idx":8},"children":["expanded_commitment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cycle_period_type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cycle_period_length"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cycle_day_type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cycle_day"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cycle_alignment_date"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accounting_code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exclude_item_booking_from_revenue_accounting"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proration_option"]}," from the ExpandedCommitment model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," to the ExpandedCommitment model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_credit_memo_item","__idx":9},"children":["expanded_credit_memo_item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new optional fields ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceSchedule"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceScheduleItem"]}," to the ExpandedCreditMemoItem model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implemented custom serialization for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceSchedule"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceScheduleItem"]}," using their respective ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to_dict()"]}," methods."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_invoice_item","__idx":10},"children":["expanded_invoice_item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new optional fields ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceSchedule"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceScheduleItem"]}," to the ExpandedInvoiceItem model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_invoice_schedule","__idx":11},"children":["expanded_invoice_schedule"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a call to ExpandedInvoiceSchedule.model_rebuild with raise_errors set to False."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expanded_invoice_schedule_booking","__idx":12},"children":["expanded_invoice_schedule_booking"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a call to model_rebuild with raise_errors set to False, which may impact error handling behavior during model rebuilding."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get_commitment_output","__idx":13},"children":["get_commitment_output"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eligible_account_conditions"]}," field is now mandatory and no longer optional."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["period_alignment_option"]}," field of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PeriodAlignmentOptionEnum"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_period_alignment_date"]}," field of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["date"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedules"]}," field which is a list of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentScheduleOutput"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert_create_commitment_input","__idx":14},"children":["upsert_create_commitment_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eligible_account_conditions"]}," from Optional to mandatory, which may require developers to ensure this field is always provided."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exclude_item_booking_from_revenue_accounting"]}," field, which may affect existing implementations relying on this field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["period_alignment_option"]}," field to specify period alignment options."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specific_period_alignment_date"]}," field to allow setting a specific date for period alignment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Introduced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedules"]}," field for creating new commitments with auto-generated periods."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert_update_commitment_input","__idx":15},"children":["upsert_update_commitment_input"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replaced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitment_number"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," fields from StrictStr to Annotated[str, Field(strict=True, max_length=...)] which may require developers to ensure their input strings adhere to the specified max lengths."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schedules"]}," field to the UpsertUpdateCommitmentInput model, allowing developers to include commitment schedules in their input."]}]}]},"headings":[{"value":"Python client library 3.13.0 changelog","id":"python-client-library-3130-changelog","depth":1},{"value":"__init__","id":"__init__","depth":2},{"value":"object_queries_api","id":"object_queries_api","depth":2},{"value":"payment_methods_api","id":"payment_methods_api","depth":2},{"value":"models/__init__","id":"models__init__","depth":2},{"value":"commitment_base_attributes","id":"commitment_base_attributes","depth":2},{"value":"commitment_input","id":"commitment_input","depth":2},{"value":"commitment_output","id":"commitment_output","depth":2},{"value":"expanded_commitment","id":"expanded_commitment","depth":2},{"value":"expanded_credit_memo_item","id":"expanded_credit_memo_item","depth":2},{"value":"expanded_invoice_item","id":"expanded_invoice_item","depth":2},{"value":"expanded_invoice_schedule","id":"expanded_invoice_schedule","depth":2},{"value":"expanded_invoice_schedule_booking","id":"expanded_invoice_schedule_booking","depth":2},{"value":"get_commitment_output","id":"get_commitment_output","depth":2},{"value":"upsert_create_commitment_input","id":"upsert_create_commitment_input","depth":2},{"value":"upsert_update_commitment_input","id":"upsert_update_commitment_input","depth":2}],"frontmatter":{"markdown":{"toc":{"hide":false}},"seo":{"title":"Python client library 3.13.0 changelog"}},"lastModified":"2026-01-28T16:35:30.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk-changelogs/python/changelog-3130","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}