Added new API method omni
channel
subscriptions_api.
Renamed the configuration
templates
api method to deployment
configuration
templates_api.
contacts_api
Added
transfer_contact
method to transfer a contact to another account under the same hierarchy.
Added
transfer_contact_with_http_info
method for transferring a contact with additional HTTP information.
creditmemosapi
Resource paths have been updated to use hyphens instead of camel case. For example,
/v1/creditmemos
is now
/v1/credit-memos
. This change affects all endpoints and requires developers to update their API calls accordingly.
Parameter names have been changed from camel case to snake case. For example,
partid
is now
part_id
. This change affects method signatures and requires developers to update their code to use the new parameter names.
debitmemosapi
Updated API endpoint paths from
/v1/debitmemos
to
/v1/debit-memos
. This change affects all methods interacting with debit memos and requires developers to update their API calls to the new endpoint format.
invoiceschedulesapi
Added
attach_invoice_schedule
method to attach charges to an invoice schedule.
Added
detach_invoice_schedule
method to detach charges from an invoice schedule.
invoices_api
The resource path for taxation items in invoices has been changed from
/v1/invoices/{invoiceKey}/taxationitems
to
/v1/invoices/{invoiceKey}/taxation-items
. This change requires developers to update any code that interacts with this endpoint to use the new path.
objectqueriesapi
Added support for querying invoice schedules with new methods: query
invoice
schedule
by
key and query
invoice
schedules.
Introduced new methods for querying rating details: query
rating
detail
by
key and query
rating
details.
Expanded supported expands for query
account
by
key and query
accounts to include
shipto
.
Expanded supported expands for query
credit
memo
item
by
key and query
credit
memo
items to include
subscriptionowner
and
credittaxationitems
.
Expanded supported expands for query
debit
memo
item
by
key and query
debit
memo
items to include
subscriptionowner
and
debittaxationitems
.
Expanded supported expands for query
invoice
item
by
key and query
invoice
items to include
subscriptionowner
.
Expanded supported expands for query
payment
by
key and query
payments to include
paymentscheduleitempayments
and
paymentscheduleitempayments.paymentscheduleitem
.
Expanded supported expands for query
payment
schedule
item
by
key and query
payment
schedule
items to include
paymentscheduleitempayments
and
paymentscheduleitempayments.payment
.
Expanded supported expands for query
subscription
by
key and query
subscriptions to include
account.shipto
.
orders_api
Added a new method
delete_order_asynchronously
to delete an order asynchronously.
Introduced
delete_order_asynchronously_with_http_info
method for additional HTTP info when deleting an order asynchronously.
paymentgatewaysapi
Added
create_predebit_notification
method to trigger a pre-debit notification for an invoice, applicable only for the Adyen payment gateway.
Added
create_predebit_notification_with_http_info
method to trigger a pre-debit notification with additional HTTP information.
payments_api
Renamed parameters
partid
to
part_id
and
itempartid
to
item_part_id
in multiple methods. This change requires developers to update their code to use the new parameter names.
Updated resource paths to use
partId
and
itemPartId
instead of
partid
and
itempartid
. This change affects API endpoint URLs and requires developers to update their code accordingly.
productrateplanchargesapi
Added method
update_product_rate_plan_charge_finance_information
to update finance information for a specific Product Rate Plan Charge Key in Zuora Billing.
Introduced method
update_product_rate_plan_charge_finance_information_with_http_info
for updating finance information with additional HTTP response details.
refunds_api
Renamed parameters
itempartid
to
item_part_id
and
refundpartid
to
refund_part_id
across multiple methods. Developers will need to update their code to use the new parameter names.
Updated resource paths to use
itemPartId
and
refundPartId
instead of
itempartid
and
refundpartid
. This change affects API endpoint paths and requires developers to update their API calls accordingly.
taxationitemsapi
Updated resource path from
/v1/taxationitems/{id}
to
/v1/taxation-items/{id}
for DELETE, GET, and PUT methods. This change requires developers to update their API endpoint paths to ensure compatibility.
models/init
Added AttachInvoiceScheduleRequest model.
Added CompareTemplateResponse model.
Added Condition model.
Added CreateDeploymentTemplateRequest model.
Added CreateOmniChannelSubscriptionRequest and CreateOmniChannelSubscriptionResponse models.
Added CreateOrderResult model.
Added CreatePaymentPredebitNotifyRequest and CreatePaymentPredebitNotifyResponse models.
Added DeleteOrderAsyncResponse model.
Added DeploymentResponse, DeploymentTemplate, and DeploymentTemplatesResponse models.
Added DetachInvoiceScheduleRequest model.
Added ExpandedCreditTaxationItem, ExpandedDebitTaxationItem, ExpandedInvoiceSchedule, and ExpandedInvoiceScheduleItem models.
Added ExpandedPaymentScheduleItemPayment model.
Added ExpandedRatingDetail model.
Added GetAsyncCreateOrderJobResponse, GetAsyncOrderJobResponseResult, and GetAsyncPreviewOrderJobResponse models.
Added GetDataLabelingJobResponse and GetDataLabelingJobResponseProgress models.
Added GetOmniChannelSubscriptionResponse model.
Added MigrateTenantSettingsRequest and MigrateTenantSettingsResponse models.
Added OmniChannelAccountData model.
Added OrderDeltaQty model.
Added PaymentMethodCardBinInfoCardClass, PaymentMethodCardBinInfoProductType, PaymentMethodRequestTokens, and PaymentMethodResponseCardBinInfo models.
Added QueryInvoiceSchedulesResponse and QueryRatingDetailsResponse models.
Added RetrieveDeploymentResponse and related models.
Added RevertDeploymentResponse model.
Added SettingSourceComponent model.
Added SubmitDataLabelingJobRequest and SubmitDataLabelingJobResponse models.
Added TransferContactRequest model.
Added WriteOffOptions, WriteOffResultTransaction, and WriteOffResults models.
Removed AsyncOrderJobResult model.
Removed AsyncOrderResultSubscriptionStatus and AsyncOrderResultSubscriptions models.
Removed CompareSchemaInfoResponse model.
Removed CreateTemplateRequestContent model.
Removed TemplateDetailResponse, TemplateMigrationClientRequest, and TemplateResponse models.
asyncorderjob_result
The class AsyncOrderJobResult has been removed entirely, which will break any code relying on this class.
asyncorderresultsubscriptionstatus
The file async
order
result
subscription
status has been removed, which may cause compatibility issues for developers relying on this file.
asyncorderresult_subscriptions
The entire AsyncOrderResultSubscriptions model has been removed, which will break any code relying on this model.
billrunfilter
Added
condition
field to support additional filtering logic.
Introduced
object_type
field with validation for enum values (
Account
,
Subscription
,
RatePlanCharge
).
billing_options
Added a new field
charge_type_to_exclude
to the BillingOptions model, allowing developers to specify types of charges to be excluded from billing document generation.
bulkpdfgenerationjobrequest
Added a new optional field
ignoreArchivedFiles
to control whether to skip archived PDF files in the output. Setting it to true will skip archived files, while setting it to false will throw an error if archived files are encountered. The default value is false.
charge_override
Added
taxable
field to indicate if a charge is taxable. If set to true,
taxCode
and
taxMode
are required.
Introduced
estimatedStartDate
field for charges, available when the Pending Charge Flexibility feature is enabled.
charge_tier
Added
originalListPrice
field to the ChargeTier model, allowing developers to access the original list price of a product or service.
charge_update
Added
estimated_start_date
field to the ChargeUpdate model, allowing developers to specify an estimated start date for charges when the Pending Charge Flexibility feature is enabled.
compareschemainfo_response
The CompareSchemaInfoResponse class has been removed entirely, which will break any code relying on this class.
createaccountpayment_method
Added
accountMaskNumber
field to the CreateAccountPaymentMethod model, allowing developers to handle masked account numbers for payment methods.
createbatchqueryjobrequest
The
version
field type has changed from
Optional[Union[StrictFloat, StrictInt]]
to
Optional[StrictStr]
. This may require developers to update their code to ensure compatibility with the new type.
createbatchqueryjobresponse
The
version
field type has changed from
Optional[Union[StrictFloat, StrictInt]]
to
Optional[StrictStr]
. This may require developers to update their code to handle version values as strings instead of numbers.
createbatchquery_response
The type of
record_count
field has changed from Optional
[StrictStr]
to Optional[Union
[StrictFloat, StrictInt]
]. This may require developers to update their code to handle numeric types instead of strings for this field.
createordercharge_update
Added
estimated_start_date
field to the CreateOrderChargeUpdate model, allowing developers to specify the estimated start date of a charge when the charge is changed through related order actions. This feature is available when the Pending Charge Flexibility feature is enabled.
createordercreate_subscription
Added
invoiceOwnerAccountNumber
field to specify the account number that will own the invoice.
Introduced
uniqueToken
field to set relatedSubscriptionNumber in OLI within the same order, ensuring uniqueness for multiple create subscription order actions.
createorderorderlineitem
Added a new optional field
uniqueToken
to the CreateOrderOrderLineItem model. This field allows setting the relatedSubscriptionNumber in OLI within the same order. The unique token should be a valid value belonging to any of the create sub-order actions within the same order.
createorderresponse
The
status
field type has changed from
Optional[StrictStr]
to
Optional[OrderStatus]
. This may require developers to update their code to handle the new
OrderStatus
type.
createpaymentmethodbanktransfer
Added a new optional field
accountMaskNumber
to the CreatePaymentMethodBankTransfer model, allowing developers to specify a masked account number for the payment method.
createpaymentmethod_request
Added
accountMaskNumber
field to store the masked account number of the payment method.
Introduced
tokenize
field to specify whether to tokenize the payment method.
Added
tokens
field of type
PaymentMethodRequestTokens
to handle token-related information.
createpaymentsession_request
Added a new optional field
gatewayOptions
to the
CreatePaymentSessionRequest
model, allowing developers to specify additional options for the payment gateway.
createrefundwithauto_unapply
Added
write_off
field to indicate whether to write off a document.
Introduced
write_off_options
field for specifying write-off options.
createtemplaterequest_content
The entire CreateTemplateRequestContent class has been removed, which will break any code relying on this class.
credit_memo
Added
tax_auto_calculation
field to the CreditMemo model, allowing automatic tax calculation for credit memos.
creditmemoresponse
Added
taxAutoCalculation
field to the CreditMemoResponse model, allowing automatic tax calculation in credit memos.
deletebatchqueryjobresponse
Changed the type of the
version
field from Optional[Union
[StrictFloat, StrictInt]
] to Optional
[StrictStr]
. This may require developers to update their code if they were using numeric types for the
version
field.
deletebatchquery_response
The type of
record_count
field has been changed from Optional
[StrictStr]
to Optional[Union
[StrictFloat, StrictInt]
]. This may require developers to update their code to handle numeric types instead of strings for this field.
einvoicestatus
Added a new status
CONDITIONALSUCCESS
to the EInvoiceStatus enum, allowing for more granular status reporting.
expanded_account
Added
ship_to_id
and
ship_to
fields to the ExpandedAccount model, allowing developers to specify and retrieve shipping information.
expanded_contact
Added new boolean fields:
asBillTo
,
asSoldTo
, and
asShipTo
to the ExpandedContact model.
expandedcreditmemo
Changed the type of
revenueImpacting
from Optional
[StrictInt]
to Optional
[StrictStr]
. This may require developers to update their code to handle the new type.
Added a new field
shipToContactSnapshotId
to the ExpandedCreditMemo model.
expandedcreditmemo_item
Changed the type of
revenue_impacting
from Optional
[StrictInt]
to Optional
[StrictStr]
, which may require developers to update their code to handle this field as a string instead of an integer.
Added
item_ship_to_contact_id
field to the ExpandedCreditMemoItem model.
Added
ship_to_contact_snapshot_id
field to the ExpandedCreditMemoItem model.
Added
subscription_owner_id
field to the ExpandedCreditMemoItem model.
Added
subscription_owner
field to the ExpandedCreditMemoItem model, which is an instance of ExpandedAccount.
Added
credit_taxation_items
field to the ExpandedCreditMemoItem model, which is a list of ExpandedCreditTaxationItem instances.
expandeddebitmemo
Added
shipToContactSnapshotId
field to the ExpandedDebitMemo model.
Added
soldToContactId
field to the ExpandedDebitMemo model.
expandeddebitmemo_item
Added
item_ship_to_contact_id
and
ship_to_contact_snapshot_id
fields to the ExpandedDebitMemoItem model.
Introduced
subscription_owner_id
and
subscription_owner
fields to the ExpandedDebitMemoItem model.
Included
debit_taxation_items
field, which is a list of ExpandedDebitTaxationItem, in the ExpandedDebitMemoItem model.
expanded_invoice
Added new optional fields
ship_to_contact_id
and
ship_to_contact_snapshot_id
to the ExpandedInvoice model.
expandedinvoiceitem
Added new field
itemShipToContactId
to track the contact ID for shipping items.
Added new field
shipToContactSnapshotId
to track the snapshot ID for shipping contact.
Added new field
shipToContactId
to track the contact ID for shipping.
Added new field
subscriptionOwnerId
to track the owner ID of the subscription.
Added new field
subscriptionOwner
to represent the expanded account of the subscription owner.
expandedorderaction
Added
subscription_number
field to the ExpandedOrderAction model.
Added
ship_to_contact_id
field to the ExpandedOrderAction model.
Added
clearing_existing_ship_to_contact
field to the ExpandedOrderAction model.
expandedorderline_item
Added new optional fields:
sequenceSetId
,
paymentTerm
, and
invoiceTemplateId
to the ExpandedOrderLineItem model.
Introduced new optional fields:
shipToId
and
shipToSnapshotId
to the ExpandedOrderLineItem model.
expanded_orders
Added
isScheduled
field to the ExpandedOrders model.
Added
cancelReason
field to the ExpandedOrders model.
expanded_payment
Added a new optional field
payment_schedule_item_payments
to the ExpandedPayment model, allowing developers to include payment schedule item payments in their payment data.
expandedpaymentschedule_item
Added a new field
paymentScheduleItemPayments
to the
ExpandedPaymentScheduleItem
model, allowing for a list of
ExpandedPaymentScheduleItemPayment
objects.
expandedprocessedusage
Changed the type of
billing_period_end_date
and
billing_period_start_date
from
Optional[StrictStr]
to
Optional[date]
. This may require developers to update their code to handle date objects instead of strings.
expandedrateplan_charge
Added new optional fields
estimatedStartDate
and
estimatedEndDate
to the ExpandedRatePlanCharge model.
expanded_subscription
Added new optional fields
ship_to_contact_id
and
ship_to_contact_snapshot_id
to the ExpandedSubscription model.
getaccountingperiodalloffieids_response
Added a new field
accountsReceivableDebitMemoAgingDetailExportFileId
to the GetAccountingPeriodAllOfFieIdsResponse model, allowing retrieval of the file ID for the Accounts Receivable Aging Debit Memo Detail report.
getasyncorderjobresponse
The
result
field type has changed from
AsyncOrderJobResult
to
GetAsyncOrderJobResponseResult
.
The
status
field type has changed from
StrictStr
to
JobStatus
.
getbatchqueryjobresponse
The
version
field type has changed from
Optional[Union[StrictFloat, StrictInt]]
to
Optional[StrictStr]
. This change may require developers to update their code to handle version values as strings instead of numbers.
getbatchquery_response
The type of
record_count
field has changed from
Optional[StrictStr]
to
Optional[Union[StrictFloat, StrictInt]]
. This may require developers to update their code to handle numeric types instead of strings.
getbulkpdfgenerationjob_response
Added
skippedDocuments
field to the GetBulkPdfGenerationJobResponse model, which includes an array of objects containing billing document types and their IDs that were skipped during execution.
getchargeoverride
Added
estimated_start_date
field for charges with Pending Charge Flexibility enabled.
Introduced
taxable
field to indicate if a charge is taxable, available with Taxation enabled.
Added
tax_mode
and
tax_code
fields for charges, available with Taxation enabled.
getcustomexchangeratestype
Added a new optional field
rateSetName
of type StrictStr to the GetCustomExchangeRatesType model. This field represents the name of the rate set configured in the Finance Manage Currency Conversion settings for the Multi-Org feature.
getsubscriptionrateplanchargeswithall_segments
Added new fields:
estimatedEndDate
,
estimatedStartDate
,
taxable
,
taxCode
, and
taxMode
to the GetSubscriptionRatePlanChargesWithAllSegments model.
intervalpricingtier
Added a new field
originalListPrice
to the
IntervalPricingTier
model, which represents the original list price of a product or service.
migrationclientresponse
The entire MigrationClientResponse model has been removed, which will cause compatibility issues for any code relying on this model.
orderactioncreate_subscription
Added
invoiceOwnerAccountNumber
field to specify the account number that will own the invoice.
Introduced
paymentProfile
field to associate a payment profile with the subscription.
orderactionowner_transfer
Added a new optional field
payment_profile
of type
PaymentProfile
to the
OrderActionOwnerTransfer
model.
orderactionrateplanamendment
Added
customFields
attribute to the OrderActionRatePlanAmendment model, allowing developers to include custom fields in amendments.
orderactionrateplancharge_override
Added
estimatedStartDate
field to the OrderActionRatePlanChargeOverride model. This field is available if the Pending Charge Flexibility feature is enabled and represents the estimated start date of the charge.
orderactionrateplancharge_update
Added
estimatedStartDate
field to the OrderActionRatePlanChargeUpdate model, which is available if the Pending Charge Flexibility feature is enabled. This field represents the estimated start date of the charge.
orderactiontermsandconditions
Added a new optional field
payment_profile
of type
PaymentProfile
to the
OrderActionTermsAndConditions
model.
paymentmethodresponse
Added a new optional field
cardBinInfo
to the
PaymentMethodResponse
model, which includes additional card information.
Updated the
to_dict()
method to include
cardBinInfo
if present, allowing for more detailed serialization of payment method data.
Enhanced the
from_dict()
method to handle the new
cardBinInfo
field, enabling deserialization of this additional data.
payment_run
The type of
organization_labels
field has changed from Optional
[StrictStr]
to Optional[List
[OrganizationLabel]
]. This may require developers to update their code to handle a list of OrganizationLabel objects instead of a single string.
Added detailed handling for
organization_labels
field, allowing it to store multiple organization labels as a list of OrganizationLabel objects. Each item in the list can be converted to a dictionary using the
to_dict()
method.
paymentrunresponse
The
organization_labels
field in
PaymentRunResponse
has been updated to accept a list of
OrganizationLabel
objects instead of a single string. This change allows for more detailed information about the organizations associated with a payment run.
previewchargemetrics
Added a new field
isPending
of type StrictBool to the PreviewChargeMetrics model.
preview_options
Added a new field
charge_type_to_exclude
to the PreviewOptions model, allowing developers to specify charge types to exclude from the forecast run.
previewordercharge_override
Added
estimated_start_date
field to specify the estimated start date of the charge.
Introduced
tax_code
,
tax_mode
, and
taxable
fields to handle tax-related information for charges.
previewordercharge_update
Added
estimated_start_date
field to PreviewOrderChargeUpdate model, which provides the estimated start date of the charge. This field is available when the Pending Charge Flexibility feature is enabled.
previewordercreate_subscription
Added
invoiceOwnerAccountNumber
field to specify the account number of an existing account that will own the invoice.
previeworderresultdeltametrics
Added support for
orderDeltaQty
in the PreviewOrderResultDeltaMetrics model, allowing developers to handle quantity changes in orders.
rateplancharge_segment
Added new fields: estimatedEndDate, estimatedStartDate, taxable, taxCode, and taxMode to the RatePlanChargeSegment model.
rateplanchargesegmentinfo
Added new fields: estimatedEndDate, estimatedStartDate, taxable, taxCode, and taxMode to RatePlanChargeSegmentInfo class.
rateplancharge_tier
Added
originalListPrice
field to the RatePlanChargeTier model, allowing developers to access the original list price of a product or service.
refund
Added a new optional field
write_off_results
of type
WriteOffResults
to the
Refund
model.
refund_response
Added a new optional field
write_off_results
of type WriteOffResults to the RefundResponse model.
settingsourcecomponent_response
The entire SettingSourceComponentResponse class has been removed, which will break any code relying on this class.
templatedetailresponse
The entire TemplateDetailResponse class has been removed, which will break any code relying on this class.
templatemigrationclient_request
The class TemplateMigrationClientRequest has been removed entirely, which will break any code relying on it.
template_response
The entire TemplateResponse class has been removed, which includes all its methods and properties. This will break any code that relies on this class.
updateproductrateplancharge_request
Changed the type of
product_rate_plan_charge_tier_data
from a list of ProductRatePlanChargeTier to a single ProductRatePlanChargeTierData object. This requires developers to update their code to handle a single object instead of a list.
writeoffinvoice_request
Added a new optional field
tax_auto_calculation
of type
StrictBool
to the
WriteOffInvoiceRequest
model, allowing automatic tax calculation in the credit memo.