- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-12-07
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.
- Orders - Added the following new operations:
- Preview order asynchronously
- Create order asynchronously
- Get job status and response
- Accounts - Made the following updates:
- In the request body of the “Create account” operation:
- Added the
soldToSameAsBillTo
field. - Changed the behavior of the
autoPay
,creditCard
, andhpmCreditCardPaymentMethodId
fields. IfautoPay
is set to false, you do not need to specifycreditCard
orhpmCreditCardPaymentMethodId
. Previously,creditCard
andhpmCreditCardPaymentMethodId
did not depend onautoPay
.
- Added the
- Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.
- In the request body of the “Create account” operation:
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later.
-
In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves.
-
In the “Create order” operation, corrected the maximum length of the following fields in the request body:
newAccount
>name
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>name
-
In the “Preview order” operation, corrected the maximum length of the
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>name
field in the request body.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-09-21
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the request body of the “Create order” operation, corrected the
subscriptions
>orderActions
>createSubscription
>terms
>renewalTerms
field from required to optional.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-09-28
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 232, September 2018.
-
Notifications - Added the
preemptive
field to thecallout
>calloutAuth
object in the request body of the following operations:- Create a notification definition
- Update a notification definition
And in the response body of the following operations:
- Query notification definitions
- Get a notification definition
This field is used to enable preemptive authentication when Zuora makes a callout to the specified domain.
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the “Create order” operation, corrected the names of the following request body fields:
processingOptions
>applyCreditBalance
processingOptions
>electronicPaymentOptions
processingOptions
>electronicPaymentOptions
>paymentMethodId
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-10-15
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 233, October 2018.
- Payments - In the request body of the “Create payment” operation, changed the
paymentMethodId
field from required to optional. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically.
2018-10-11
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 233, October 2018.
-
Orders - Made the following updates:
- Added a new operation “Request breakdown of invoice items by order”.
- In the “Create order” operation, added the
creditMemoTemplateId
anddebitMemoTemplateId
fields to the following fields in the request body:newAccount
subscription
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
-
Credit Memos - Added a new operation “Request breakdown of credit memo items by order”.
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the following operations, updated the notes to clarify that migration to full Orders is in Limited Availability:
- Preview order
- Create order
- Delete order
- Update subscription custom fields
- Update order action trigger dates
-
In all operations relevant to the Invoice Settlement feature, added the missing
No
enum value to thetransferredToAccounting
field. -
In the “Get credit memos” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:accountId
amount
appliedAmount
autoApplyUponPostingbalance
beAppliedAmount
createdById
createdDate
creditMemoDate
currency
excludeFromAutoApplyRulesurrency
debitMemoDate
dueDate
number
referredInvoiceId
refundAmount
status
targetDate
taxAmount
totalTaxExemptAmount
transferredToAccounting
unappliedAmount
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the “Get credit memo items” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:amount
appliedAmount
createdById
createdDate
id
refundAmount
serviceEndDate
serviceStartDate
sku
skuName
sourceItemId
subscriptionId
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the “Get debit memos” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:accountId
amount
balance
beAppliedAmount
createdById
createdDate
currency
debitMemoDate
dueDate
number
referredInvoiceId
status
targetDate
taxAmount
totalTaxExemptAmount
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the “Get debit memo items” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:amount
beAppliedAmount
createdById
createdDate
id
serviceEndDate
serviceStartDate
sku
skuName
sourceItemId
subscriptionId
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the “Get payment runs” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:createdById
createdDate
status
targetDate
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the “Get all payments” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:accountId
amount
appliedAmount
createdById
createdDate
creditBalanceAmount
currency
effectiveDate
number
refundAmount
status
type
unappliedAmount
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the “Get all refunds” operation, removed the
fieldsFilterable
query parameter. This query parameter was a placeholder for the following query parameters:accountId
amount
createdById
createdDate
methodType
number
paymentId
refundDate
status
type
updatedById
updatedDate
These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.
-
In the following operations, added
/v1
to the examples in description of thesort
query parameter:- Get all payments
- Get all refunds
-
Corrected the 200 responses of the following actions:
- Create
- Execute
- Generate
- Subscribe
- Update
Previously, each 200 response was documented as an object containing a field called
result
. -
In the request body of the “CRUD: Create payment method” operation, and in the
subscribes
>PaymentMethod
object in the request body of the “Subscribe” operation, made the following updates:- Updated the description of the
TokenId
field to clarify that the value must beAmazonBillingAgreementId
to create an Amazon Pay payment method. - Updated the description of the
Type
field to clarify that the value must beCreditCardReferenceTransaction
to create an Amazon Pay payment method.
- Updated the description of the
-
In the source YAML file, changed the
OrderMetricsForEvergreen
reference object from an array to an object. -
In the source YAML file, removed the following reference objects:
ProxyActiondeleteResponse
BaseObject
TriggerCondition
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-10-18
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the following operations, corrected the possible values of the
status
field in the response body:- Get subscriptions by key
- Get subscriptions by key and version
Previously, the value
Pending Activation
was incorrectly listed asPendingActivation
, and the valuePending Acceptance
was incorrectly listed asPendingAcceptance
. -
In the “Get subscriptions by account” operation, corrected the possible values of the
subscriptions
>status
field in the response body.Previously, the value
Pending Activation
was incorrectly listed asPendingActivation
, and the valuePending Acceptance
was incorrectly listed asPendingAcceptance
. -
In the “CRUD: Retrieve Subscription” operation, corrected the possible values of the
status
field in the response body.Previously, the value
Pending Activation
was incorrectly listed asPendingActivation
, and the valuePending Acceptance
was incorrectly listed asPendingAcceptance
. -
In the “CRUD: Update Subscription” operation, corrected the possible values of the
status
field in the request body.Previously, the value
Pending Activation
was incorrectly listed asPendingActivation
, and the valuePending Acceptance
was incorrectly listed asPendingAcceptance
. -
In the “Post usage” operation, changed the following headings from required to optional. Although the values for the following headings are not required, the heardings themselves must exist in the upload CSV file.
- ENDDATE
- SUBSCRIPTION_ID
- CHARGE_ID
-
At the beginning of the Accounts section, explained similar operations are provided for different use scenarios.
-
At the beginning of the Subscription Product Features section, noted that the Entitlements feature must be enabled to use the operation.
-
In the “CRUD: Delete amendment” operation, explained that invoiced amendments cannot usually be deleted, unless it is the last auto-renew amendment.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-10-26
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the description of the “Scrub payment method” operation, replaced the outdated note with the latest prerequisites of using this operation.
- In the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the missing parameters and removed the inapplicable ones.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-11-08
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 234, November 2018.
-
Orders - Made the following updates:
-
In the “Create order” operation, made the following updates to the request body:
- Added the
includedUnits
field to thesubscriptions
>orderActions
>updateProduct
>chargeUpdates
>pricing
field. - Added the
additionalEmailAddresses
,customerServiceRepName
,purchaseOrderNumber
,salesRep
, andallowInvoiceEdit
fields to the following fields:newAccount
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
- Added the
contactDescription
field to the following fields:newAccount
>billToContact
newAccount
>soldToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
- Added the
revRecCode
,revenueRecognitionRuleName
, andrevRecTriggerCondition
fields to thesubscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
field.
- Added the
-
In the “Preview order” operation, made the following updates to the request body:
- Added the
includedUnits
field to thesubscriptions
>orderActions
>updateProduct
>chargeUpdates
>pricing
field. - Added the
taxInfo
nested field to thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
field. - Added the
additionalEmailAddresses
,customerServiceRepName
,purchaseOrderNumber
,salesRep
, andallowInvoiceEdit
fields to thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
field. - Added the
contactDescription
field to the following fields:subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
- Added the
revRecCode
,revenueRecognitionRuleName
, andrevRecTriggerCondition
fields to thesubscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
field.
- Added the
-
In the “Get an order” operation, added the
revRecCode
,revenueRecognitionRuleName
, andrevRecTriggerCondition
fields to theorder
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
field in the response body. -
In the following operations, added the
contactDescription
field to theorders
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
field in the response body:- Get all orders
- Get orders by subscription owner
- Get orders by subsription number
- Get orders by invoice owner
-
-
Payment Methods - Made the following updates:
- Added support for custom fields in the request body of the following operations:
- Create payment method
- Create credit card payment method
- Update credit card payment method
- CRUD: Create payment method
- CRUD: Update payment method
- Added a note to the description of the
accountID
,accountKey
, orAccountId
field in the following operations to explain when the ID of customer account can be optional:- Create credit card payment method
- Create Apple Pay payment method
- Update credit card payment method
- CRUD: Create payment method
- CRUD: Update payment method
- Added support for custom fields in the request body of the following operations:
-
Accounts - Added support for custom fields to the
creditCard
object in the request body of the ‘‘Create account’’ operation. -
Notifications - Made the following updates:
- Added the
eventTypeNamespace
field to the request body of the following operations:- Create a notification definition
- Create an email template
- Added the
eventTypeNamespace
field to the 200 response schema of the following operations:- Create a notification definition
- Query notification definitions
- Update a notification definition
- Get a notification definition
- Create an email template
- Query email templates
- Update an email template
- Get an email template
- Added the
-
Invoices - In the response body of the “Get invoice items” operation, added the nested
appliedToItemId
field to theinvoiceItems
field. -
Operations - In the response body of the “Create billing preview” operation, added the nested
appliedToItemId
field to the following fields:invoiceItems
creditMemoItems
-
Transactions - In the response body of the “Get invoices” operation, added the nested
reversed
field to theinvoices
field.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-11-15
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the “Create order” operation, made the following updates:
- Added the requirement on setting a default payment method for the
newAccount
field in the request body. - Added the option to use the
returnIds
parameter in the endpoint so that the IDs associated with the numbers (for example,subscriptionNumber
,invoiceNumber
, and so on) can be returned in the response.
- Added the requirement on setting a default payment method for the
-
In the request body of the “Create payment” operation, updated the description of the
gatewayId
field to clarify that this field is required when creating electronic payments but optional when creating external payments.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-12-07
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.
- Orders - Added the following new operations:
- Preview order asynchronously
- Create order asynchronously
- Get job status and response
- Accounts - Made the following updates:
- In the request body of the “Create account” operation, changed the behavior of the
autoPay
,creditCard
, andhpmCreditCardPaymentMethodId
fields. IfautoPay
is set to false, you do not need to specifycreditCard
orhpmCreditCardPaymentMethodId
. Previously,creditCard
andhpmCreditCardPaymentMethodId
did not depend onautoPay
. - Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.
- In the request body of the “Create account” operation, changed the behavior of the
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later.
-
In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves.
-
In the “Create order” operation, corrected the maximum length of the following fields in the request body:
newAccount
>name
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>name
-
In the “Preview order” operation, corrected the maximum length of the
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>name
field in the request body.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.
For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!
2018-12-14
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.
- Orders - Made the following updates:
- In the request body of the “Create order” operation:
- Added nested fields called
suspend
andresume
to thesubscriptions
>orderActions
field. - Added possible values
Suspend
andResume
to thesubscriptions
>orderActions
>type
field.
- Added nested fields called
- In the response body of the “Create order” operation, added a possible value
Suspended
to thesubscriptions
>status
field. - In the request body of the “Preview order” operation:
- Added nested fields called
suspend
andresume
to thesubscriptions
>orderActions
field. - Added possible values
Suspend
andResume
to thesubscriptions
>orderActions
>type
field.
- Added nested fields called
- In the following operations, added nested fields called
suspend
andresume
to theorder
>subscriptions
>orderActions
field of the response body:- Get an order
- Get order metrics for evergreen subscription
- In the following operations, added possible values
Suspend
andResume
to thesubscriptions
>orderActions
>type
field of the response body:- Get an order
- Get order metrics for evergreen subscription
- In the following operations, added nested fields called
suspend
andresume
to theorders
>subscriptions
>orderActions
field of the response body:- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
- In the following operations, added possible values
Suspend
andResume
to theorders
>subscriptions
>orderActions
>type
field of the response body:- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
- In the request body of the “Create order” operation:
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the Zuora Object Model section, added the following objects to the table of API names:
- Feature
- Product Feature
- Subscription Product Feature
- In the “Create order” operation, added a note about the Suspend and Resume feature.
- In the following operations, updated the note about the Orders feature:
- Preview order
- Preview order asynchronously
- Create order
- Create order asynchronously
- Delete order
- Get job status and response
- Update subscription custom fields
- Update order action trigger dates
- In the following operations, updated the note about the Order Metrics feature:
- Get all orders
- Get an order
- Get billing information for order
- Get term information for subscription
- Get order metrics for evergreen subscription
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
- Get breakdown of invoice by order
- Request breakdown of invoice items by order
- Get rated result for order
- Update order custom fields
2018-12-07
API Updates
This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.
- Orders - Added the following new operations:
- Preview order asynchronously
- Create order asynchronously
- Get job status and response
- Accounts - Made the following updates:
- In the request body of the “Create account” operation, changed the behavior of the
creditCard
andhpmCreditCardPaymentMethodId
fields. IfautoPay
is set to false, you do not need to specifycreditCard
orhpmCreditCardPaymentMethodId
. - Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.
- In the request body of the “Create account” operation, changed the behavior of the
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later.
-
In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves.
-
In the “Create order” operation, corrected the maximum length of the following fields in the request body:
newAccount
>name
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>name
-
In the “Preview order” operation, corrected the maximum length of the
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>name
field in the request body.