2023 Changelog
This page summarizes the changes that are made to the API Reference for Billing, Collect, and Central Platform in 2023.
For release notes for all Zuora products, see Latest releases.
March 24, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.03.R2. For release notes for all Zuora products, see Latest releases.
API updates for the Offers feature
The following items are the API updates specific to the Offers feature.
-
Offers
- Added a resource called "Offers", with the following operations:
- Create an offer
- List all offers
- Retrieve an offer
- Delete an offer
-
Price Book Items
- Added a resource called "Price Book Items", with the following operations:
- Create a price book item
- Update a price book item
- List all price book items
- Retrieve a price book item
- Delete a price book item
API updates for the Delivery Pricing charge model
The following items are the API updates specific to the Delivery Pricing charge model.
-
Product Rate Plan Charges
- In the request body of each of the following operations:
- CRUD: Create a product rate plan charge
- CRUD: Update a product rate plan charge
Made the following updates:
-
Added the
DeliverySchedule
field and its nested fields. -
Added the
Delivery Pricing
enum value to theChargeModel
field.
-
Product Rate Plans
- In the response body of the “List product rate plans” operation, made the following updates:
-
Added the
productRatePlans
>productRatePlanCharges
>deliverySchedule
field and its nested fields. -
Added the
Delivery
enum value to theproductRatePlans
>productRatePlanCharges
>model
field.
-
Added the
Other API updates
The following items are the other general API updates included in this release:
-
Accounts
- In the request body of the "Create an account" operation, added the following fields:
-
paymentMethod
>ipAddress
-
paymentMethod
>accountHolderInfo
>country
-
-
Orders
- In the request body of each of the following operations:
- Create an order
- Create an order asynchronously
- Update an order
Added the following fields:
-
newAccount
>paymentMethod
>ipAddress
-
newAccount
>paymentMethod
>accountHolderInfo
>country
-
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>paymentMethod
>ipAddress
-
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>paymentMethod
>accountHolderInfo
>country
-
Payment Methods
- In the request body of each of the following operations:
- Create a payment method
- Update a payment method
Added the following fields:
-
ipAddress
-
accountHolderInfo
>country
-
Sign Up
- In the request body of the "Sign up" operation, added the
ipAddress
nested field to thenewAccount
>paymentMethod
field.
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the source YAML file, made the following changes to the "Sign up" operation:
-
Renamed the
PaymentMethod
definition toSignUpPaymentMethod
. -
Renamed the
CreatePaymentMethodCreditCardReferenceTransaction
definition toSignUpCreatePaymentMethodCreditCardReferenceTransaction
. -
Renamed the
CreatePMPayPalECPayPalNativeEC
definition toSignUpCreatePMPayPalECPayPalNativeEC
. -
Renamed the
CreatePaymentMethodPayPalAdaptive
definition toSignUpCreatePaymentMethodPayPalAdaptive
. -
Renamed the
CreatePaymentMethodCreditCard
definition toSignUpCreatePaymentMethodCreditCard
. -
Renamed the
CreatePaymentMethodCommon
definition toCreatePaymentMethodCommon
. -
Renamed the
PaymentMethodObjectCustomFields
definition toSignUpPaymentMethodObjectCustomFields
. -
Renamed the
CreatePaymentMethodCardholderInfo
definition toSignUpCreatePaymentMethodCardholderInfo
.
-
Renamed the
-
In the request body of each of the following operations, aligned descriptions of the fields for creating stored credential profiles:
- Create a payment method
- Create a stored credential profile
-
In the description of the "Retrieve a rate plan" operation, added a note to clarify that you can only retrieve information about the following order actions:
-
addProduct
-
updateProduct
-
removeProduct
-
changePlan
-
- Updated the limitations for the "Delete an account" operation.
-
In the request body of the "Create an order" operation, updated the refunding requirements in the description of the
processingOptions
>refund
field.
March 17, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.03.R1. For release notes for all Zuora products, see Latest releases.
-
Adjustments
- In the request body of each of the following operations, added the
chargeNumbers
field:- Create an adjustment
- Preview an adjustment
-
Orders
- Made the following updates:
-
In the request body of each of the following operations:
- Preview an order
- Preview an order asynchronously
Added the following fields and their nested fields:
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
In the request body of each of the following operations:
- Create an order
- Create an order asynchronously
- Update an order
Added the following fields and their nested fields:
-
subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringDeliveryBased
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringDeliveryBased
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
In the response body of each of the following operations:
- List orders
- List orders of a subscription owner
- List orders by subscription number
- List orders of an invoice owner
- List pending orders by subscription number
Added the following fields and their nested fields:
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
orders
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
orders
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
orders
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
orders
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
In the response body of the "Retrieve an order" operation, added the following fields and their nested fields:
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
order
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringFlatFee
>priceIntervals
-
order
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringPerUnit
>priceIntervals
-
order
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringTiered
>priceIntervals
-
order
>subscriptions
>orderActions
>addProduct
>chargeOverrides
>pricing
>recurringVolume
>priceIntervals
-
- In the description of the "Create an order" operation, deleted a limitation for draft orders.
-
In the request body of each of the following operations:
-
Subscriptions
- Made the following updates:
-
In the request body of the "Update a subscription" operation, added the following fields:
-
bookingDate
-
add
>bookingDate
-
change
>bookingDate
-
remove
>bookingDate
-
update
>bookingDate
-
-
In the request body of each of the following operations, added the
bookingDate
field:- Cancel a subscription
- Resume a subscription
- Suspend a subscription
-
In the request body of the "Update a subscription" operation, added the following fields:
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
Doc updates for passing in email information when creating payment methods
The following items are the documentation updates specific to the clarification that the email
field is only supported for creating PayPal payment methods:
-
In the request body of the "Create a payment method" operation, updated the description of the
email
field. -
In the request body of the "Create an account" operation, updated the description of the
paymentMethod
>email
field. -
In the request body of the "Sign up" operation, updated the description of the
accountData
>paymentMethod
>email
field. -
In the request body of each of the following operations:
- Create an order
- Create an order asynchronously
Updated the description of each of the following fields:
-
newAccount
>paymentMethod
>email
-
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>paymentMethod
>email
Other doc updates
The following items are the other general documentation updates included in this release:
-
In the request body of the "Update a payment method" operation, updated the description of each of the following fields to clarify that the field is not supported for updating Credit Card Reference Transaction payment methods:
-
authGateway
-
gatewayOptions
-
accountHolderInfo
- Custom fields
-
-
In the request body of each of the following operations, added descriptions for the
subscriptions
>orderActions
>updateProduct
>chargeUpdates
>pricing
field and its nested fields:- Create an order
- Create an order asynchronously
-
In the response body of each of the following operations, added descriptions for the
orders
>subscriptions
>orderActions
>updateProduct
>chargeUpdates
>pricing
field and its nested fields:- List orders
- List orders of a subscription owner
- List orders by subscription number
- List orders of an invoice owner
- List pending orders by subscription number
-
For each of the following operations, added the missing
exclude-rate-plans-with-no-charges
query parameter:- List subscriptions by account key
- Retrieve a subscription by key
- Retrieve a subscription by key and version
-
In the response body of the "Retrieve an order" operation, added descriptions for the
order
>subscriptions
>orderActions
>updateProduct
>chargeUpdates
>pricing
field and its nested fields. -
In the source YAML file, added the
CreateOfferRatePlanOverride
definition, and updated the request body schema reference of each of the following operations to this definition:- Create an order
- Update an order
-
In the source YAML file, added the
GetOfferRatePlanOverride
definition, and updated the request body schema reference of each of the following operations to this definition:- List orders
- List orders of a subscription owner
- List orders by subscription number
- List orders of an invoice owner
- List pending orders by subscription number
-
In the source YAML file, added the
GetOfferRatePlanUpdate
definition, and updated the request body schema reference of each of the following operations to this definition:- List orders
- List orders of a subscription owner
- List orders by subscription number
- List orders of an invoice owner
- List pending orders by subscription number
-
In the response body of the "Retrieve an invoice" operation, updated the description of the
templateId
field for better clarity.
March 10, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.03.R1. For release notes for all Zuora products, see Latest releases.
API updates for the Offers feature
The following items are the API updates specific to the Offers feature.
-
Orders
- Made the following updates:
-
In the request body of each of the following operations:
- Create an order
- Create an order asynchronously
- Update an order
Added the following fields:
-
subscriptions
>orderActions
>createSubscription
>subscribeToProducts
-
subscriptions
>orderActions
>addProduct
>productOfferId
-
subscriptions
>orderActions
>addProduct
>productOfferNumber
-
subscriptions
>orderActions
>addProduct
>ratePlanOverrides
-
subscriptions
>orderActions
>updateProduct
>subscriptionOfferNumber
-
subscriptions
>orderActions
>updateProduct
>subscriptionOfferId
-
subscriptions
>orderActions
>updateProduct
>subscriptionOfferUniqueToken
-
subscriptions
>orderActions
>updateProduct
>ratePlanUpdates
-
subscriptions
>orderActions
>removeProduct
>subscriptionOfferNumber
-
subscriptions
>orderActions
>removeProduct
>subscriptionOfferId
-
subscriptions
>orderActions
>removeProduct
>subscriptionOfferUniqueToken
-
In the response body of each of the following operations:
- List orders
- List orders of a subscription owner
- List orders by subscription number
- List orders of an invoice owner
- List pending orders by subscription number
Added the following fields:
-
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
-
orders
>subscriptions
>orderActions
>addProduct
>productOfferId
-
orders
>subscriptions
>orderActions
>addProduct
>productOfferNumber
-
orders
>subscriptions
>orderActions
>addProduct
>newSubscriptionOfferId
-
orders
>subscriptions
>orderActions
>addProduct
>newSubscriptionOfferNumber
-
orders
>subscriptions
>orderActions
>addProduct
>subscriptionOfferUniqueToken
-
orders
>subscriptions
>orderActions
>addProduct
>ratePlanOverrides
-
orders
>subscriptions
>orderActions
>updateProduct
>subscriptionOfferId
-
orders
>subscriptions
>orderActions
>updateProduct
>productOfferNumber
-
orders
>subscriptions
>orderActions
>updateProduct
>subscriptionOfferNumber
-
orders
>subscriptions
>orderActions
>updateProduct
>subscriptionOfferUniqueToken
-
orders
>subscriptions
>orderActions
>updateProduct
>ratePlanUpdates
-
orders
>subscriptions
>orderActions
>removeProduct
>subscriptionOfferId
-
orders
>subscriptions
>orderActions
>removeProduct
>subscriptionOfferNumber
-
orders
>subscriptions
>orderActions
>removeProduct
>subscriptionOfferUniqueToken
-
In the response body of the "Retrieve an order" operation, added the following fields:
-
order
>subscriptions
>orderActions
>createSubscription
>subscribeToProducts
-
order
>subscriptions
>orderActions
>addProduct
>productOfferId
-
order
>subscriptions
>orderActions
>addProduct
>productOfferNumber
-
order
>subscriptions
>orderActions
>addProduct
>newSubscriptionOfferId
-
order
>subscriptions
>orderActions
>addProduct
>newSubscriptionOfferNumber
-
order
>subscriptions
>orderActions
>addProduct
>subscriptionOfferUniqueToken
-
order
>subscriptions
>orderActions
>addProduct
>ratePlanOverrides
-
order
>subscriptions
>orderActions
>updateProduct
>subscriptionOfferId
-
order
>subscriptions
>orderActions
>updateProduct
>productOfferNumber
-
order
>subscriptions
>orderActions
>updateProduct
>subscriptionOfferNumber
-
order
>subscriptions
>orderActions
>updateProduct
>subscriptionOfferUniqueToken
-
order
>subscriptions
>orderActions
>updateProduct
>ratePlanUpdates
-
order
>subscriptions
>orderActions
>removeProduct
>subscriptionOfferId
-
order
>subscriptions
>orderActions
>removeProduct
>subscriptionOfferNumber
-
order
>subscriptions
>orderActions
>removeProduct
>subscriptionOfferUniqueToken
-
-
In the request body of each of the following operations:
-
Subscriptions
- Made the following updates:
-
In the response body of the "List subscriptions by account key" operation, added the
subscriptions
>offers
field. -
In the response body of each of the following operations, added the
offers
field:- Retrieve a subscription by key
- Retrieve a subscription by key and version
-
In the response body of the "List subscriptions by account key" operation, added the
API updates for the Delivery Pricing charge model
The following items are the API updates specific to the Delivery Pricing charge model.
-
Subscriptions
- Made the following updates:
-
In the response body of each of the following operations:
- Retrieve a subscription by key
- Retrieve a subscription by key and version
Added the following fields:
-
ratePlans
>ratePlanCharges
>deliverySchedule
-
ratePlans
>ratePlanCharges
>subscriptionChargeIntervalPricing
-
In the response body of each of the following operations, added the
Delivery
enum value to theratePlans
>ratePlanCharges
>model
field:- Retrieve a subscription by key
- Retrieve a subscription by key and version
-
In the response body of the "List subscriptions by account key" operation, added the following fields:
-
subscriptions
>ratePlans
>ratePlanCharges
>deliverySchedule
-
subscriptions
>ratePlans
>ratePlanCharges
>subscriptionChargeIntervalPricing
-
-
In the response body of the "List subscriptions by account key" operation, added the
Delivery
enum value to thesubscriptions
>ratePlans
>ratePlanCharges
>model
field.
-
In the response body of each of the following operations:
API updates for the Scheduled Orders feature
The following items are the API updates specific to the Scheduled Orders feature.
-
Orders
- Made the following updates:
- In the description of the "Cancel an order" operation, added a note to clarify that cancellation is only valid for draft or scheduled orders.
-
In the description of each of the following operations, added a note to clarify that you cannot retrieve detailed information about draft orders or scheduled orders through this operation:
- List orders of a subscription owner
- List orders of an invoice owner
-
In the request body of each of the following operations, added the
status
andschedulingOptions
fields:- Create an order
- Update an order
-
In the response body of each of the following operations:
- List orders
- List orders by subscription number
Made the following updates:
-
Added the
Scheduled
,Executing
, andFailed
enum values to theorders
>status
field. -
Added the
orders
>schedulingOptions
field.
-
In the response body of the "Retrieve an order" operation, made the following updates:
-
Added the
Scheduled
,Executing
, andFailed
enum values to thestatus
field. -
Added the
schedulingOptions
field.
-
Added the
API updates for the Adjustments feature
The following items are the API updates specific to the Adjustments feature.
-
Adjustments
- Added a resource called "Adjustments", with the following operations:
- Create an adjustment
- List all adjustments of the latest version subscription
- Retrieve an adjustment
- Preview an adjustment
- Cancel an adjustment
Other API updates
The following items are the other general API updates included in this release:
-
Subscriptions
- In the request body and response body of the "Preview a subscription" operation, added the
documentDate
field. - Order Actions - Added an API operation called "Update an order action".
-
Accounts
- Made the following updates:
-
In the response body of the "Retrieve an account" operation, added the
autoPay
field nested field to thebillingAndPayment
field. -
In the response body of the "Retrieve an account summary" operation, added the
autoPay
field nested field to thebasicInfo
field.
-
In the response body of the "Retrieve an account" operation, added the
-
Credit Memos
- Made the following updates:
-
In the response body of each of the following operations, added the
billToContactSnapshotId
field:- Create a credit memo from a charge
- Create a credit memo from an invoice
- Retrieve a credit memo
- Update a credit memo
- Apply a credit memo
- Unapply a credit memo
- Cancel a credit memo
- Post a credit memo
- Unpost a credit memo
-
In the response body of each of the following operations, added the
billToContactSnapshotId
nested field to thememos
field:- Create credit memos
- Update credit memos
-
In the response body of the "List credit memos" operation, added the
billToContactSnapshotId
nested field to thecreditmemos
field.
-
In the response body of each of the following operations, added the
-
Debit Memos
- Made the following updates:
-
In the response body of each of the following operations, added the
billToContactSnapshotId
field:- Create a debit memo from a charge
- Create a debit memo from an invoice
- Retrieve a debit memo
- Update a debit memo
- Cancel a debit memo
- Post a debit memo
- Unpost a debit memo
-
In the response body of each of the following operations, added the
billToContactSnapshotId
nested field to thememos
field:- Create debit memos
- Update debit memos
-
In the response body of the "List debit memos" operation, added the
billToContactSnapshotId
nested field to thedebitmemos
field.
-
In the response body of each of the following operations, added the
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the request body of the "Update a subscription" operation, updated the description of each of the following fields to state that the field is not updatable:
-
add
>chargeOverrides
>originalOrderDate
-
change
>chargeOverrides
>originalOrderDate
-
-
In the request body of each of the following operations, updated the description of the
processingOptions
>applyCredit
field for better clarity:- Create an order
- Create an order asynchronously
- Update an order
March 3, 2023
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the request body of each of the following operations, added a limitation on the Change Plan order action in the description of the
subscriptions
>orderActions
>changePlan
>effectivePolicy
field.:- Preview an order
- Preview an order asynchronously
- Create an order
- Create an order asynchronously
- Update an order
-
In the request body of the "Update a subscription" operation, added a limitation on the Change Plan amendment in the description of the
change
>effectivePolicy
field. -
In the request body of the "Update a subscription" operation, updated the description of the
change
>chargeOverrides
>amendedByOrderOn
field to state that the field is not updatable. -
In the request body of the "Create a payment schedule" operation, updated the description of each of the following fields:
-
runHour
-
items
>runHour
-
-
In the request body of the "Create multiple payment schedules at once" operation, updated the description of each of the following fields:
-
paymentSchedules
>runHour
-
paymentSchedules
>items
>runHour
-
-
In the request body of the "Add payment schedule items to a custom payment schedule" operation, updated the description of the
items
>runHour
field. -
In the request body of each of the following operations, updated the description of the
runHour
field:- Update a payment schedule item
- Update a payment schedule
- Preview the result of payment schedule updates
February 24, 2023
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the response body of the "Retrieve an order" operation, updated the description of the
order
>subscriptions
>orderActions
>updateProduct
>ratePlanId
field to clarify that the version ID of the history can also be used. -
In the request body of the "Create an account" operation, removed the unsupported
country
nested field from thepaymentMethod
>accountHolderInfo
field. -
In the request body of each of the following operations, removed the unsupported
country
nested field from thenewAcccount
>paymentMethod
>accountHolderInfo
field:- Create an order
- Create an order asynchronously
-
In the request body of each of the following operations, removed the unsupported
country
nested field from theaccountHolderInfo
field:- Create a payment method
- Update a payment method
-
In the source YAML file, added the
PUTOrderRequestType
definition, and updated the request body schema reference of the "Update an order" operation to this definition. -
In the source YAML file, renamed the
PaymentMethod
definition toPostOrderAccountPaymentMethod
for the following operations:- Create an order
- Create an order asynchronously
February 21, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.02.R2. For release notes for all Zuora products, see Latest releases.
-
Bill Runs
- In the response body of each of the following operations, added the
name
field:- Create a bill run
- Post a bill run
- Cancel a bill run
- Retrieve a bill run
The following API updates are available as of Zuora Release 2023.02.R1.
-
Usage
- In the response body of the "Retrieve a usage record" operation, added the
fileName
field.
API updates for the paymentOption field
The following items are the API updates specific to the paymentOption
field that is only available if you set zuora-version
to 337.0
or later.
-
Payment Schedules
- Made the following updates:
-
In the request body and response body of each of the following operations, added the
paymentOption
field:- Create a payment schedule
- Preview the result of payment schedule update
- Update a payment schedule
- Update a payment schedule item
-
In the request body and response body of each of the following operations, added the
paymentOption
nested field to theitems
field:- Add payment schedule items to a custom payment schedule
- Create a payment schedule
-
In the request body of the "Create multiple payment schedules at once" operation, added the
paymentOption
nested field to each of the following fields:-
paymentSchedules
-
paymentSchedules
>items
-
-
In the response body of each of the following operations, added the
paymentOption
field:- Cancel a payment schedule
- Cancel a payment schedule item
- List payment schedules by customer account
- Retrieve a payment schedule
- Retrieve a payment schedule item
- Skip a payment schedule item
-
In the response body of each of the following operations, added the
paymentOption
nested field to theitems
field:- Cancel a payment schedule
- List payment schedules by customer account
- Preview the result of payment schedule update
- Retrieve a payment schedule
- Retry failed payment schedule items
- Update a payment schedule
-
In the "Create a payment schedule" operation, added the following fields to the description of the
zuora-version
request header:-
paymentOption
-
items
>paymentOption
-
-
In the "Create multiple payment schedules at once" operation, added the following fields to the description of the
zuora-version
request header:-
paymentSchedules
>paymentOption
-
paymentSchedules
>items
>paymentOption
-
-
In each of the following operations, added the
paymentOption
field to the description of thezuora-version
request header:- Update a payment schedule item
- Update a payment schedule
- Preview the result of payment schedule update
- Retrieve a payment schedule
- Retrieve a payment schedule item
- List payment schedules by customer account
- Cancel a payment schedule
- Cancel a payment schedule item
- Skip a payment schedule item
-
In each of the following operations, added the
items
>paymentOption
field to the description of thezuora-version
request header:- Add payment schedule items to a custom payment schedule
- Retry failed payment schedule items
- Retrieve a payment schedule
- Cancel a payment schedule
-
In the request body and response body of each of the following operations, added the
-
Payments
- Made the following updates:
-
For the "Create a payment" operation, made the following updates:
-
In the request body and response body, added the
paymentOption
field. -
In the description of the
zuora-version
request header, added thepaymentOption
field.
-
In the request body and response body, added the
-
For the "List payments" operation, made the following updates:
-
In the response body, added the
paymentOption
nested field to thepayments
field. -
In the description of the
zuora-version
request header, addedpayments
>paymentOption
.
-
In the response body, added the
-
For the "Create a payment" operation, made the following updates:
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the response body of the "CRUD: Retrieve a bill run" operation, added the following missing enum values to the
Status
field:-
PostInProgress
-
CancelInProgress
-
RemoveInProgress
-
Paused
-
- Updated the description of the "Create an OAuth token" operation.
-
In the "API Versions" section, added the following missing fields to the "Minor Version History" table:
-
billingDocument
-
paymentId
-
linkPayments
-
unlinkPayments
-
psiPayments
-
-
In the "Update a payment schedule item" operation, added the missing
zuora-version
request header. -
In each of the following operations, added the missing fields in version control to the description of the
zuora-version
request header:- Create a payment schedule
- Create multiple payment schedules at once
- List payment schedules by customer account
- Retrieve a payment schedule
- Update a payment schedule
- Preview the result of payment schedule updates
- Cancel a payment schedule
- Add payment schedule items to a custom payment schedule
- Retrieve a payment schedule item
- Update a payment schedule item
- Cancel a payment schedule item
- Skip a payment schedule item
- Retry failed payment schedule items
-
Moved the following CRUD operations to the Older API Reference to avoid confusion:
- CRUD: Delete an account
- CRUD: Create a bill run
- CRUD: Retrieve a bill run
- CRUD: Post or cancel a bill run
- CRUD: Delete a bill run
- CRUD: Retrieve an invoice
- CRUD: Delete an invoice
-
In the request body of the "Amend" action in the Older API Reference, corrected the name of the
requests
>Amendments
>bookingDate
field torequests
>Amendments
>BookingDate
.
February 13, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.02.R1. For release notes for all Zuora products, see Latest releases.
-
Bill Runs
- Added the following operations:
- Create a bill run
- Post a bill run
- Cancel a bill run
- Retrieve a bill run
- Delete a bill run
-
Orders
- Made the following updates:
-
Added the following operations only applied to orders in
Draft
status:- Update an order
- Activate an order
- Cancel an order
-
In the request body of the "Create an order" operation, added the
status
field. -
In the response body of the "Create an order" operation, added the
Draft
enum value to thestatus
field. -
In the response body of each of the following operations, added the
Draft
enum value to theorders
>status
field:- List orders
- List orders by subscription number
- List pending orders by subscription number
-
In the response body of the "Retrieve an order" operation, added the
Draft
enum value to theorder
>status
field. -
In the description of each of the following operations, added a note to clarify that you cannot retrieve the detailed information about draft orders:
- List orders of a subscription owner
- List orders of an invoice owner
-
Added the following operations only applied to orders in
-
Custom Object Jobs
- For the "List all custom object bulk jobs" operation, added a query parameter called
status
that accepts the status of bulk jobs.
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the description of the "List all settings" operation, added the following common use cases for notification definitions:
-
In the description of each of the following operations, added an alternative Settings API operation that applies to standard, custom, and custom scheduled events:
- List notification definitions
- Retrieve a notification definition
- Update a notification definition
- Delete a notification definition
-
For the "List all custom object bulk jobs" operation, removed the unsupported
page
query parameter. -
Added the "Reporting" section that contains the following operations to the Older API Reference:
- Retrieve a report run
- Cancel a report run
- Run a report
- Search reports by name
- Retrieve the last completed report run
- Retrieve report data
- Export results of a report run
Previously, these operations were documented in the Knowledge Center.
February 2, 2023
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Relocated the following files:
- Source Swagger file: https://www.zuora.com/developer/yaml/swagger.yaml
- Settings API CSV file: https://www.zuora.com/developer/settings-api/ListAllSettingsResponseSample.csv
- Settings API JSON file: https://www.zuora.com/developer/settings-api/ListAllSettingsResponseSample.json
Previously, they were located in the assets.zuora.com domain. For information about other relocated resources, see this Community post.
-
Removed the
Idempotency-Key
header parameter from all PUT and GET methods. -
For the
AllCustomObjects
andCustomObject
settings of Settings API, corrected the name of each of the following fields by capitalizing the first letter:-
Id
-
CreatedById
-
UpdatedById
-
CreatedDate
-
UpdatedDate
-
-
In the response body of the "List all product rate plans of a product" operation, added the
ConsumptionBased
enum value back to thecreditOption
>productRatePlans
>productRatePlanCharges
field. -
In the request body of each of the following operations, added the
ConsumptionBased
enum value back to theCreditOption
field:- CRUD: Create a product rate plan charge
- CRUD: Update a product rate plan charge
-
In the response body of the "List subscriptions by account key" operation, added the
ConsumptionBased
enum value back to thesubscriptions
>ratePlans
>ratePlanCharges
>creditOption
field. -
In the response body of each of the following operations, added the
ConsumptionBased
enum value back to theratePlans
>ratePlanCharges
>creditOption
field:- Retrieve a subscription by key
- Retrieve a subscription by key and version
January 19, 2023
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Updated the default MIME type for all operations from
application/json;charset=utf-8
toapplication/json
. -
In the request body of the "Create a payment method" operation, updated the description of the
bankAccountName
field to clarify requirements specific to the BlueSnap integration. -
In the request body of the "Create an account" operation, updated the description of the
paymentMethod
>bankAccountName
field to clarify requirements specific to the BlueSnap integration. -
In the request body of the "Create an order" operation, updated the description of the
newAccount
>paymentMethod
>bankAccountName
field to clarify requirements specific to the BlueSnap integration. - Fixed the broken links in the description of the "Payment Gateway Reconciliation" section.
-
Updated the description of each of the following operations:
- Upload a usage file
- Update an account
- List all products
- List all product rate plans of a product
- Refund a payment
- Delete a payment method
- Create a credit memo from a charge
- Create a notification definition
- Create an order
- Preview an order
- CRUD: Update a contact
- CRUD: Update a payment method
- List all invoices for an account
-
In the request body of the "CRUD: Create a product rate plan" operation, updated the description of the
ActiveCurrencies
field. -
In the response body of the "List subscriptions by account key" operation, updated the description of the
subscriptions
>ratePlans
>lastChangeType
field. -
In the response body of each of the following operations, updated the description of the
ratePlans
>lastChangeType
field:- Retrieve a subscription by key
- Retrieve a subscription by key and version
-
In the description of the
subscription-key
path parameter of the "Update a subscription" operation, suggested retrieving the latest or history version of the subscription ID before updating a specific version of the subscription. -
In the response body of the "Retrieve an order line item" operation, corrected the data type of the
orderLineItem
>productRatePlanChargeId
field. - In the description of the "Cancel a payment schedule" operation, clarified that only pending payment schedule items will be canceled.
-
In the response body of each of the following operations:
- Retrieve a payment schedule item
- Update a payment schedule item
- Cancel a payment schedule item
- Skip a payment schedule item
Updated the description of each of the following fields to state the requirement on the API version:
-
balance
-
psiPayments
-
In the response body of each of the following operations:
- Create a payment schedule
- List payment schedule by customer account
- Create multiple payment schedules at once
- Retrieve a payment schedule
- Add payment schedule items to a custom payment schedule
- Retry failed payment schedule items
Updated the description of each of the following fields to state the requirement on the API version:
-
items
>balance
-
items
>psiPayments
January 13, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.01.R2. For release notes for all Zuora products, see Latest releases.
API updates for the Flexible Billing feature
The following items are the API updates specific to the Flexible Billing feature.
-
Subscriptions
- Made the following updates:
-
In the response body of the "List subscriptions by account key" operation, added the following nested field to the
subscriptions
field:-
invoiceTemplateName
-
sequenceSetName
-
-
In the response body of each of the following operations, added the
invoiceTemplateName
andsequenceSetName
fields:- Retrieve a subscription by key
- Retrieve a subscription by key and version
-
In the response body of the "List subscriptions by account key" operation, added the following nested field to the
API updates for the Billing Schedule feature
The following items are the API updates specific to the Early Adopter announcement of the Billing Schedule feature.
-
Orders
- Made the following updates:
-
In the response body of each of the following operations, added the
invoiceScheduleId
nested field to theorder
field:- Retrieve an order
- List order metrics for an evergreen subscription
-
In the response body of each of the following operations, added the
invoiceScheduleId
nested field to theorders
field:- List orders
- List orders of a subscription owner
- List orders by subscription number
- List orders of an invoice owner
- List pending orders by subscription number
-
In the response body of each of the following operations, added the
-
Subscriptions
- Made the following updates:
-
In the response body of the "List subscriptions by account key" operation, added the
invoiceScheduleId
nested field to thesubscriptions
field: -
In the response body of each of the following operations, added the
invoiceScheduleId
field:- Retrieve a subscription by key
- Retrieve a subscription by key and version
-
In the response body of the "List subscriptions by account key" operation, added the
API updates for the Payment Schedules feature
The following items are the API updates specific to the Payment Schedules feature.
-
Payment Schedules
- Made the following updates:
-
In the request body of the “Update a payment schedule item” operation, added the following fields to support linking multiple payments to a payment schedule item:
-
linkPayments
-
unlinkPayments
-
-
In the response body of each of the following operations:
- Retrieve a payment schedule item
- Update a payment schedule item
- Cancel a payment schedule item
- Skip a payment schedule item
Added the following fields to support linking multiple payments to a payment schedule item and payment schedule item balance:
-
balance
-
psiPayments
-
In the response body of each of the following operations:
- Create a payment schedule
- List payment schedule by customer account
- Create multiple payment schedules at once
- Retrieve a payment schedule
- Add payment schedule items to a custom payment schedule
- Retry failed payment schedule items
Added the following fields to support linking multiple payments to a payment schedule item and payment schedule item balance:
-
items
>balance
-
items
>psiPayments
-
In the request body of the “Update a payment schedule item” operation, added the following fields to support linking multiple payments to a payment schedule item:
Other API updates
The following items are the other general API updates included in this release:
- Accounts - Added an operation called "Delete an account".
-
Invoices
- Made the following updates:
- Added an operation called "Retrieve an invoice".
-
In the request body of the "Post invoices" operation, added the support for custom fields to the
invoices
field.
- Custom Object Jobs - Added an operation called "Cancel a custom object bulk job".
-
Communication Profiles
- In the response body of the "CRUD: Retrieve a communication profile" operation, added the following fields:
-
IsDefault
-
Muted
-
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Updated the description of each of the following actions:
- Create
- Update
-
In the request body of each of the following operations, removed the unsupported
SubmissionDateTime
field:- CRUD: Create a usage record
- CRUD: Retrive a usage record
- CRUD: Update a usage record
- In the description of the “Update a payment schedule item” operation, added notes on linking and unlinking multiple payments to a payment schedule item.
-
In the response body of the "List credit memo items" operations, added the missing
OrderLineItem
enum value to each of the following fields:-
items
>sourceItemType
-
items
>sourceItemId
-
-
In the response body of the "Retrive a credit memo item" operation, added the missing
OrderLineItem
enum value to each of the following fields:-
sourceItemType
-
sourceItemId
-
-
In the response body of the "List credit memos” operation, added the missing
Order
,CreditMemo
, andConsolidation
enum values to thecreditmemos
>sourceType
field. -
In the response body of each of the following operation, added the missing
Order
,CreditMemo
, andConsolidation
enum values to thememos
>sourceType
field:- Create credit memos
- Update credit memos
-
In the response body of each of the following operations, added the missing
Order
,CreditMemo
, andConsolidation
enum values to thesourceType
field:- Retrive a credit memo
- Create a credit memo from a charge
- Create a credit memo from an invoice
- Update a credit memo
- Apply a credit memo
- Cancel a credit memo
- Post a credit memo
- Unapply a credit memo
- Unpost a credit memo
January 6, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of Zuora Release 2023.01.R1.
-
Settings
- Added the
Per_Specific_Months
enum value to thelistPriceBase
parameter of theBillingListPriceBase
setting.
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the request body of each of the following operations, updated the description of the
gatewayOptions
field by adding a link to the relevant article in the Knowledge Center:- Create a payment method
- Update a payment method
- Verify a payment method
- Create authorization
- Cancel authorization
- Create a payment
- Refund a payment
-
In the request body of the “Create a standalone invoice” operation, updated the description of the
invoiceItems
>unitPrice
field to state this field is required for passing Level 3 card data to the gateway. -
In the request body of the “Create standalone invoices” operation, updated the description of the
invoices
>invoiceItems
>unitPrice
field to state this field is required for passing Level 3 card data to the gateway. - In each of the Orders operations and Order Line Items operations, updated the general availability note about the Orders feature.
-
In the request body of the “Create a standalone invoice” operation, added a note to the description of each of the following fields about the permission control information:
-
invoiceItems
>taxItems
-
invoiceItems
>discountItems
>taxItems
-
-
In the request body of the “Create standalone invoices” operation, added a note to the description of each of the following fields about the permission control information:
-
invoices
>invoiceItems
>taxItems
-
invoices
>invoiceItems
>discountItems
>taxItems
-