Skip to content

Python client library 3.21.0 changelog

account_basic_info

  • Added new field default_payment_method_id.

charge_override

  • Added new field is_billable.
  • Added new field parent_charge_number.
  • Added new field parent_unique_token.

create_account_request

  • Added new field associate_commitment_number.

create_account_response

  • Added new field re_association_result.

create_invoice_item

  • Added new field rev_rec_start_date.

create_order_create_subscription

  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field ship_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

create_order_order_line_item

  • Added new field billing_schedule.
  • Added new field number_of_validity_periods.
  • Added new field specific_validity_period_length.
  • Added new field validity_period_type.
  • Removed field fund_credit_option.
  • Removed field is_rollover.
  • Removed field rollover_apply.
  • Removed field rollover_end_date.
  • Removed field rollover_end_date_type.
  • Removed field rollover_fund_priority.
  • Removed field rollover_period_length.
  • Removed field rollover_periods.
  • Removed field rollover_period_type.
  • Removed field vp_proration_option.

create_order_response

  • Added new field re_association_results.

create_order_result

  • Added new field re_association_results.

create_order_subscription_owner_account

  • Added new field associate_commitment_number.
  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

create_order_terms_and_conditions

  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field ship_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

create_product_rate_plan_charge_request

  • Deprecated field vp_alignment. Use validity_period_alignment instead.
  • Deprecated field vp_proration_option. Use validity_period_proration_option instead.

credit_memo_item_from_invoice_item

  • Added new field contribute_to_commitment.

credit_memos_api

  • Added new parameter compliance_activity_type to the method download_e_invoice_file_for_credit_memo.

debit_memo_item_from_invoice_item_request

  • Added new field contribute_to_commitment.

debit_memos_api

  • Added new parameter compliance_activity_type to the method download_e_invoice_file_for_debit_memo.

e_compliance_api

  • Added new parameter compliance_activity_type to the method download_e_compliance_file.
  • Added new method create_e_invoice_lifecycle_status_update.
  • Added new method download_e_compliance_file_by_parent.
  • Added new method download_e_compliance_snapshot_by_parent.
  • Added new method get_e_invoice_lifecycle_status_update.
  • Added new method get_e_invoice_lifecycle_status_updates.

e_reporting_request_vo

  • Added new field authority_status.
  • Added new field business_status.

expanded_child_commitment

  • Added new field exclude_item_booking_from_revenue_accounting.
  • Added new field revenue_model.
  • Removed field account_id.
  • Removed field account_number.

expanded_commitment

  • Added new field exclude_item_booking_from_revenue_accounting.
  • Added new field revenue_model.
  • Removed field account.
  • Removed field account_id.
  • Removed field account_number.

expanded_commitment_associated_account

  • Added new field status.

expanded_commitment_transaction

  • Added new field billing_document_id.
  • Added new field billing_document_type.

expanded_invoice

  • Added new field credit_memo_applications.
  • Added new field credit_memo_parts.
  • Added new field payment_applications.
  • Added new field payment_parts.

expanded_payment_method

  • Added new field network_token_provider.
  • Added new field network_token_type.

expanded_product_rate_plan_charge

  • Added new field commitment_level.
  • Added new field drawdown_priority.
  • Added new field drawdown_scope.
  • Added new field fund_support_account_hierarchy.
  • Added new field prepayment_unit_type.
  • Added new field rollover_end_date_type.
  • Added new field rollover_fund_priority.
  • Added new field rollover_period_type.
  • Added new field specific_validity_period_length.
  • Added new field validity_period_alignment.
  • Added new field validity_period_proration_option.

expanded_rate_plan_charge

  • Added new field bundle_charge_type.
  • Added new field commitment_level.
  • Added new field drawdown_priority.
  • Added new field drawdown_scope.
  • Added new field fund_support_account_hierarchy.
  • Added new field is_billable.
  • Added new field parent_charge_number.
  • Added new field prepayment_unit_type.
  • Added new field rollover_end_date.
  • Added new field rollover_end_date_type.
  • Added new field rollover_fund_priority.
  • Added new field rollover_period_type.
  • Added new field specific_validity_period_length.
  • Added new field validity_period_alignment.
  • Added new field validity_period_anchor_date.
  • Added new field validity_period_proration_option.

fulfillment_item

  • Added new field fulfillment_number.

get_async_create_order_job_response

  • Added new field re_association_results.

get_async_preview_order_job_response

  • Added new field funds.

get_charge_override

  • Added new field is_billable.
  • Added new field parent_charge_number.

get_fulfillment_item

  • Added new field fulfillment_number.

get_order_line_item

  • Added new field billing_schedule.
  • Added new field number_of_validity_periods.
  • Added new field specific_validity_period_length.
  • Added new field validity_period_type.
  • Removed field fund_credit_option.
  • Removed field is_rollover.
  • Removed field rollover_apply.
  • Removed field rollover_end_date.
  • Removed field rollover_end_date_type.
  • Removed field rollover_fund_priority.
  • Removed field rollover_period_length.
  • Removed field rollover_periods.
  • Removed field rollover_period_type.
  • Removed field vp_proration_option.

get_product_rate_plan_charge_response

  • Deprecated field vp_alignment. Use validity_period_alignment instead.
  • Deprecated field vp_proration_option. Use validity_period_proration_option instead.

get_subscription_rate_plan_charges_with_all_segments

  • Added new field bundle_charge_type.
  • Added new field is_billable.
  • Added new field parent_charge_number.

invoice_item

  • Added new field rev_rec_start_date.

invoice_settlement_async_job_operation_type

  • Added new enum value ASYNCPAYMENTAPPLY.
  • Added new enum value ASYNCPAYMENTCREATE.

invoice_settlement_async_job_reference_type

  • Added new enum value PAYMENT.

invoices_api

  • Added new parameter compliance_activity_type to the method download_e_invoice_file_for_invoice.

object_queries_api

  • Added new method query_credit_memo_part_by_key.
  • Added new method query_credit_memo_parts.
  • Added new method query_payment_part_by_key.
  • Added new method query_payment_parts.

order_action_owner_transfer

  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field ship_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

order_action_renew_subscription

  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field ship_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

order_action_terms_and_conditions

  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field ship_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

order_create_account

  • Added new field associate_commitment_number.

order_line_item

  • Added new field number_of_validity_periods.
  • Added new field specific_validity_period_length.
  • Added new field validity_period_type.
  • Removed field fund_credit_option.
  • Removed field is_rollover.
  • Removed field rollover_apply.
  • Removed field rollover_end_date.
  • Removed field rollover_end_date_type.
  • Removed field rollover_fund_priority.
  • Removed field rollover_period_length.
  • Removed field rollover_periods.
  • Removed field rollover_period_type.
  • Removed field vp_proration_option.

order_line_items_api

  • Added new method update_order_line_item_billing_schedule_items.

orders_api

  • Added new method get_order_delta_metrics_by_order_number.
  • Added new method rescan_commitment_account_associations.

payment_methods_api

  • Added new method add_gateway_profile_data.

payments_api

  • Added new method apply_payment_async.
  • Added new method create_payment_async.
  • Added new method get_apply_payment_async_job.
  • Added new method get_create_payment_async_job.

preview_options

  • Added new field document_date.
  • Added new enum value FUNDS.

preview_order_charge_override

  • Added new field is_billable.

preview_order_create_subscription

  • Changed field bill_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field ship_to_contact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field sold_to_contact type from CreateAccountContact to OrderCreateAccountContact.

preview_order_result

  • Added new field funds.

processing_options

  • Added new field re_association.

processing_options_with_delayed_capture_payment

  • Added new field re_association.

product_rate_plan_charge

  • Deprecated field vp_alignment. Use validity_period_alignment instead.
  • Deprecated field vp_proration_option. Use validity_period_proration_option instead.

rate_plan

  • Removed RatePlan. Use CreateOrderRatePlanOverride instead.

regenerate_booking_request

  • Added new field commitment_id.
  • Added new field commitment_period_id.

subscription_data

  • Changed field rate_plans type from RatePlan list to CreateOrderRatePlanOverride list.

update_invoice_item

  • Added new field rev_rec_start_date.

update_product_rate_plan_charge_request

  • Deprecated field vp_alignment. Use validity_period_alignment instead.
  • Deprecated field vp_proration_option. Use validity_period_proration_option instead.

zuora_client

  • Added PrepaidWithDrawdownApi.