Zuora SOAP API Version History
This article documents the schema changes made to each version of Zuora SOAP WSDL, starting with the releases in the second half of 2015.
See the related release notes for detail information about the changes.
WSDL Version | Release Date (Zuora Version) |
Object and Field Changed | Permission Control? | Description |
---|---|---|---|---|
147 | Zuora Release 2024.Q4.0.0 | Invoice.Currency | No | See Invoice for more information. |
146 | Zuora Release 2024.08.R1 | Usage.ProductRatePlanChargeNumber added | Yes | Field added for the Dynamic Usage Charges feature. |
144 | Zuora Release 2024.03.R1 |
|
No | The two objects are deprecated as they are rarely used by customers. |
141 | Zuora Release 2024.02.R1 | ProductRatePlanCharge.ChargeFunction | Yes | Field added for the Unbilled Usage feature. |
138 | Zuora Release 2023.10.R2 | ProductRatePlanCharge.Formula | Yes | Field added for the Attribute-based Pricing feature. |
137 | Zuora Release 2023.10.R1 |
EmailHistory added, containing the following fields:
CalloutHistory added, containing the following fields:
|
No | See Notification History - Email and Notification History - Callout for more information. |
137 | Zuora Release 2023.10.R1 | Account.PaymentMethodCascadingConsent | Yes | Fields added for the Cascading Payment Method feature. |
137 | Zuora Release 2023.09.R2 |
|
Yes | Fields added for the Prepaid with Drawdown feature. |
137 | Zuora Release 2023.09.R2 | Subscription.Currency | No | See the Subscription object for more information. |
136 | Zuora Release 2023.09.R1 |
RatePlanCharge.OriginalRatePlanId |
No | See the Rate Plan object for more information. |
135 | Zuora Release 2023.08.R1 |
|
Yes | Fields added for the Advanced Consumption Billing feature. |
134 | Zuora Release 2023.07.R2 |
RatingResult added, containing the following fields:
BillingPeriod added, containing the following fields:
|
Yes | Fields added for the Unbilled Usage feature. |
134 | Zuora Release 2023.07.R2 |
Fund added, containing the following fields:
PrepaidBalance added, containing the following fields:
ValidityPeriodSummary added, containing the following fields:
DailyConsumptionSummary added, containing the following fields:
|
Yes | Fields added for the Prepaid with Drawdown feature. |
133 | Zuora Release 2023.06.R2 | ProductRatePlanCharge.CommitmentType | Yes | Field added for the Unbilled Usage feature. |
133 | Zuora Release 2023.06.R2 |
|
No | Fields added to support natural key for product catalog objects. |
133 | Zuora Release 2023.04.R2 |
|
Yes | Fields added for the Prepaid with Drawdown feature. |
133 | Zuora Release 2023.04.R2 |
|
Yes | Fields added for the Prepaid with Drawdown feature. |
133 | Zuora Release 2023.04.R2 |
SubscriptionOffer added, containing the following fields:
|
Yes | Fields added for the Offers feature. |
133 | Zuora Release 2023.04.R2 |
OrderSchedule added, containing the following fields:
|
Yes | Fields added for the Scheduled Orders feature. |
133 | Zuora Release 2023.04.R2 |
SubscriptionChargePriceInterval added, containing the following fields:
|
Yes | Fields added for the Offers feature. |
133 | Zuora Release 2023.04.R2 |
SubscriptionChargePriceIntervalTier added, containing the following fields:
|
Yes | Fields added for the Offers feature. |
133 | Zuora Release 2023.04.R2 |
SubscriptionChargeDeliverySchedule added, containing the following fields:
|
Yes | Fields added for the Delivery Pricing feature. |
`132 | Zuora Release 2023.04.R1 |
|
No | See the Subscription object for more information. |
132 | Zuora Release 2023.04.R1 |
|
Yes | Fields added for Zuora Revenue. |
132 | Zuora Release 2023.04.R1 |
|
Yes | Fields added for Zuora Revenue. |
131 | Zuora Release 2023.03.R2 |
|
No | Fields added for the Export call. |
131 | Zuora Release 2023.03.R2 | RatePlanCharge.IsStackedDiscount | No |
This field is only applicable to the Discount - Percentage charge model. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:
For more information, see Stacked discounts. |
130 | Zuora Release 2023.02.R2 |
ProductRatePlanCharge.IsStackedDiscount |
No |
This field is only applicable to the Discount - Percentage charge model. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:
For more information, see Stacked discounts. |
130 | Zuora Release 2023.02.R2 | ProductRatePlan.ExternalRatePlanIds | No | The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores. |
129 | Zuora Release 2022.12.R2 |
ProductRatePlanCharge.SpecificListPriceBase |
Yes |
The number of months for the list price base of the charge. This field is available only if you have the Annual List Price feature enabled. The value of this field is |
129 | Zuora Release 2022.12.R2 | RatePlanCharge.SpecificListPriceBase | Yes |
The number of months for the list price base of the charge. This field is available only if you have the Annual List Price feature enabled. The value of this field is |
128 | Zuora Release 2022.11.R4 |
ProductRatePlanCharge.DeliverySchedule added, containing the following fields:
|
Yes | Fields added for the Delivery Pricing feature. |
128 | Zuora Release 2022.11.R4 | Invoice.CreditMemoAmount | Yes |
The currency amount of all credit memos applied to this invoice. This field is only available if you have Invoice Settlement enabled. |
127 | Zuora Release 2022.11.R1 |
|
No |
|
126 | Zuora Release 2022.09.R1 | RefundTransactionLog.ServiceType | No | Service type on the Refund Transaction Log object. |
126 | Zuora Release 2022.09.R1 |
OrderAction added, containing the following fields:
|
No | Fields added to support order actions. |
126 | Zuora Release 2022.09.R1 |
|
No |
|
126 | Zuora Release 2022.09.R1 | PaymentTransactionLog.ServiceType | No | Service type on the Payment Transaction Log object. |
124 | Zuora Release 2022.07.R2 | Subscription.IsLatestVersion added | No | Indicates whether the current subscription object is the latest version. |
122 | Zuora Release 2022.07.R2 | Subscription.LastBookingDate | No |
An enhancement is made to the |
Zuora Release 2022.07.R2 |
|
No |
See the detail information in RatePlan and RatePlanCharge. |
|
116 | Zuora Release 2022.05.R3 | ProductRatePlan.Grade added | Yes | The grade that is assigned for the product rate plan. |
122 | Zuora Release 2022.05.R2 | Subscription.LastBookingDate added | No | The last change date of a subscription. The value of this field is as follows:
|
121 | Zuora Release 2022.04.R4 |
|
Yes |
The value of either field is
|
121 | Zuora Release 2022.04.R4 | Yes | An error code enhancement is made to the create() call on the Payment object. A failed call that occurs when a null value is specified for the PaymentMethodId field returns the INVALID_VALUE error code. Previously, it was UNKNOWN_ERROR . |
|
118 | Zuora Release 2022.03.R5 | Yes |
|
|
118 | Zuora Release 2022.03.R3 |
|
No |
|
117 | Zuora Release 2022.03.R5 | InvoiceItemAdjustment.ExcludeItemBillingFromRevenueAccounting added | Yes | A boolean field on the Invoice Item Adjustment object. |
116 | Zuora Release 2022.03.R5 | InvoiceItem.ExcludeItemBillingFromRevenueAccounting added | Yes | A boolean field on the Invoice Item object. |
115 | Zuora Release 2022.03.R5 |
|
Yes | Boolean fields on the Product Rate Plan Charge and Rate Plan Charge objects. |
115 | Zuora Release 2022.03.R5 | Subscription.PaymentTerm added | No | The name of the payment term associated with the subscription. |
115 | Zuora Release 2022.01.R3 |
|
No |
|
114 | Zuora Release 2021.12.R1(R314) |
|
No | See Query Processed Usage for information. |
114 | Zuora Release 2022.03.R3 |
|
Yes |
Note: These fields are only available if you have the Prepaid with Drawdown feature enabled. See Fields related to prepaid with drawdown feature for descriptions. See Upload usage record with unique key for descriptions. |
110 | November 2021 (R313) | Yes |
To provide more effective error codes and messages, the following enhancements are made to the create() call on the PaymentMethod object:
|
|
110 | October 2021 (R311) | No | For better clarity, a failed subscribe() call to Avalara now returns ‘TRANSACTION_FAILED’ error response. Previously it was ‘UNKNOWN_ERROR’. | |
107 | January 2021 (R290) | Subscription.Revision added | No | An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the Revision value will be increased by 1. Also, the Revision value is always incremental regardless of the deletion of subscription versions. |
Yes |
The applied or unapplied amount of the payment. Note: These fields are only available if you have the Invoice Settlement feature enabled. |
|||
103 | July 2020 (R280) | Export.Encoding added | No | Specifies whether to include a byte order mark (BOM) at the beginning of exported CSV data. |
102 |
March 2020 (R270) |
BillRun.Batch renamed to BillRun.Batches | No | The specific batches of customer accounts to be included in the bill run. |
101 | September 2019 (R256) | BillRun.NumberOfCreditMemos added | No | The number of credit memos generated by the bill run. |
101 | August 2019 (R255) | BillRun.PostedDate added | No | The date when the bill run was posted. |
100 | August 2019 (R253) | No | Query the status of tax calculation for invoices, and message about the status of tax calculation. | |
96 | April 2019 (R243) | Account.SequenceSetId added | No | The ID of a billing document sequence set to assign to a customer account. |
94 | March 2019 (R242) |
PaymentMethod.MitNetworkTransactionId added |
No | Specifies the ID of a network transaction. |
94 | March 2019 (R241) |
|
No | Create a stored credential profile. |
91 | May 2018 (R224) | TaxableItemSnapshot.TaxExemptEntityUseCode added | Yes | A unique entity use code to apply exemptions in Avalara AvaTax. |
89 | Feb. 2018 (R221) | Invoice.AutoPay added | No | Whether invoices are automatically picked up for processing in the corresponding payment run. |
88 | Sep. 2017 (R216.2) |
|
No | Specify or query the city, state, country, and postal code information for ACH payment methods. |
85 | April 2017 (R211) |
|
No |
Query contact snapshot. |
No |
Query apply details info of the discount product rate plan charge. |
|||
|
No | Query apply details info of the discount rate plan charge. | ||
|
No | The date the Payment Method Snapshot was updated. This new field cannot be modified or deleted. |
||
|
No | Specify or query the discount class of discount charge. | ||
|
No |
Specify or query the discount charge apply details info. |
||
|
No |
Query apply details info from the discount rate plan charge. |
||
No |
When posting an invoice, these fields will be populated with the latest contact snapshot ID. |
|||
84 |
|
Yes | You can query the balances of invoice and taxation item before applying payment or credit memo to them. | |
82 | Dec. 2016 (R207) |
|
Yes |
You can manually create/query/delete taxable item snapshot. |
81 | Oct. 2016 (R205) |
|
No |
An optional field for the create, update, and query operation of AccountingPeriod. |
|
Yes |
Support auto-renewal for BillingPreviewRun and BillingPreviewRequest. |
||
80 | Sep. 2016 (R204) |
|
No |
For Discount item, this field describes which InvoiceItem the discount is applied to. |
79 | Aug. 2016 (R203) |
|
No | The Permission control was removed for these fields as the Weekly Billing features are in GA. |
|
Yes |
|||
78 | July 2016 (R202) |
|
No |
Specify one or more currencies you want to use in ISO currency codes. |
|
No |
The fields are now generally available and no longer permission controlled. |
||
77 |
|
Yes |
Currency of the payment. |
|
76 | April 2016 (R199) |
|
Yes |
Create a suspend or resume subscription amendment through SOAP calls.
|
The |
Yes | Delete an accounting period or a chart of account using SOAP API. | ||
75 | Feb. 2016 (R197) |
Tenant-specific custom fields on the following objects included in WSDL: |
No | |
74 |
|
Yes |
Supports getting and setting a Rating Group in SOAP calls |
|
|
Yes |
Supports getting and setting a weekly Billing Cycle Day in SOAP calls |
||
|
No |
You can override PriceIncreasePercentag and PriceChangeOption in subscription |
||
|
Yes |
The field type changed from Starting in WSDL v.74, you can split invoices based on a decimal percentage. |
||
|
Yes |
The new values, Week and Specific Weeks, are supported. You can set billing period to weekly or specific weeks through SOAP calls. |
||
|
Yes |
The new value, Week, is supported. You can set the list price base to weekly or specific weeks through SOAP calls. |
||
|
No | The field type changed from string to zns:ID |
||
73 |
|
No |
Subscription Term and Renewal Term can be specified in days, weeks, months, or years. |
|
72 | Nov. 2015 (R194) |
|
No |
Specifies the charge end condition when creating or updating Product Rate Plan Charges and Rate Plan Charges. |
|
No |
Specifies whether to include draft invoice items in preview results. |
||
71 | Oct. 2015 (R193) |
|
No |
The date when the future-dated UpdateProduct amendment takes effect. |
70 | Sep. 2015 (R192) |
|
Yes |
Specifies whether to bill in advance or in arrears for recurring charge types. |
|
Yes |
Used when calculating taxes based on origin and sold-to addresses in Avalara. |
||
69 | Aug. 2015 (R191) |
|
No |
ACH address fields required for Vantiv Payment Gateway |
|
No |
The tenant-level permission, BankTransfer, is removed. |
||
69 |
|
No |
Field type changed from |
|
68 | June 2015 (R189) |
|
No |
Supports the charge level metrics |