Quickstart API Changelog
From Zuora Release 2022.09.R1, the Quickstart API is available to customers with the Orders (or Order Harmonization) and Invoice Settlement features enabled. The Quickstart API allows new integrators to swiftly integrate with Zuora, and it supports essential business use cases.
This changelog outlines the latest API updates and resolved issues to the Quickstart API, and documentation updates to the Quickstart API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the Changelog for the Quickstart API, please send an e-mail to docs@zuora.com.
January 16, 2023
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of January 16, 2023.
-
Orders
- Added the "Orders" section that contains the following operations:
- Create an order
- Preview an order
- Retrieve an order
-
Invoices
- Added the "Invoices" section that contains the following operations:
- Create an invoice
- Retrieve an invoice
- List all invoices
-
Credit Memos
- Added the "Credit Memos" section that contains the following operations:
- Create a credit memo
- Apply a credit memo
- Unapply a credit memo
- Post a credit memo
- Unpost a credit memo
- Retrieve a credit memo
- List all credit memos
-
Debit Memos
- Added the "Debit Memos" section that contains the following operations:
- Create a debit memo
- Retrieve a debit memo
- List all debit memos
-
Accounts
- Made the following updates:
-
In the request body of each of the following operations, added the
sales_rep
field:- Create an account
- Update an account
-
In the response body of each of the following operations, added the
sales_rep
field:- Retrieve an account
- List all accounts
-
In the request body of each of the following operations, added the
-
Added the following query parameters to the List operations on all objects:
-
page_size
-
sort[]
-
December 20, 2022
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of December 20, 2022.
-
Contacts
- Made the following updates:
- Added the "Scrub a contact" operation.
-
In the request body of each of the following operations, renamed the
nick_name
field tonickname
:- Create a contact
- Update a contact
-
In the 200 response of each of the following operations, renamed the
nick_name
field tonickname
:- Create a contact
- Update a contact
- Retrieve a contact
- List all contacts
Resolved issues
This section lists the issues that have been resolved as of December 20, 2022.
We have resolved the following issues:
-
An issue that prevented you from setting the
state
field of a tax certificate toverified
using the following operations:- Create an account
- Update an account
-
An issue that prevented you from specifying the sales representative associated with an account using one of the following operations:
- Create an account
- Update an account
-
An issue that prevented you from setting the
reason_code
field when creating credit memos from invoices, using the "Create a billing document" operation. - An unexpected error was thrown when running a workflow with the required parameters using the "Run a workflow" operation.
December 9, 2022
Resolved issues
This section lists the issues that have been resolved as of December 9, 2022.
We have resolved the following issue:
-
In the response body of each of the following operations, some fields on the custom object were not returned:
- List custom objects
- Create a custom object
- Retrieve a custom object
- Update a custom object
December 5, 2022
API Updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of December 5, 2022.
-
In all "Create" and "Update" requests of Zuora standard objects, added the
expand[]
query parameter. It allows you to expand related objects when creating or updating an object, and the related objects will be expanded in the response. -
Payment Methods
- In the request body of the "Create a payment method" operation, updated the
account_id
field to an optional field. -
Custom Objects
- In the following operations, added the
expand[]
query parameter:- Retrieve a custom object
- List custom objects Note that you can expand Zuora objects to related custom objects by specifying the custom objects' plural names.
-
Subscriptions
- In the
filter[]
query parameter of the following operations, added support for filtering byend_date
:- Retrieve a subscription
- List all subscriptions
Resolved issues
This section lists the issues that have been resolved as of December 5, 2022.
We have resolved the following issues:
-
When the
apply
field was set totrue
in the request body of the "Create a billing document" operation, the credit memo was not automatically applied. -
The
price_id
field on the billing document item was not returned in the response body of the following operations:- List billing document items
- Retrieve a billing document
- List all billing documents
-
When the
account_data
field was specified in the request body of the "Preview a subscription" operation, an error occurred.
November 21, 2022
API changes
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of November 21, 2022.
-
Contacts
- Made the following updates:
-
In the request body of each of the following operations, renamed the
nickname
field tonick_name
: - Create a contact
- Update a contact
-
In the 200 response of each of the following operations, renamed the
nickname
field tonick_name
: - Create a contact
- Update a contact
- Retrieve a contact
- List all contacts
-
In the request body of each of the following operations, renamed the
-
Refunds
- In the 200 response body of each of the following operations, added the
comment
field:- Create a refund
- Update a refund
- Retrieve a refund
- List all refunds
Resolved issues
This section lists the issues that have been resolved as of November 21, 2022.
We have resolved the following issues:
-
The
updated_time
field of the Billing Document Item object was not returned in the 200 response body of the following operations:- Create a billing document
- Retrieve a billing document
- List all billing documents
- List billing document items
-
The
reason_code
field of the Billing Document object was not returned in the 200 response body of the following operations:- Create a billing document
- Retrieve a billing document
- List all billing documents
-
The
description
field of the Refund object was not returned in the 200 response of the following operations:- Create a refund
- Update a refund
- Retrieve a refund
- List all refunds
-
The
active_currencies
field of the Plan object was not returned in the 200 response body of the following operations:- Create a plan
- Update a plan
- Retrieve a plan
- List all plans
-
If you specified an unknown field called
payment_gateway
in the request using the “Create a payment method” operation, this field was incorrectly identified as thegateway_id
field instead ofpayment_gateway
in the error response.
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Updated the description of the Quickstart API Reference to highlight that the following features must be enabled to use the Quickstart API:
- Orders or Orders Harmonization
- Invoice Settlement
-
Removed the misdocumented
account_number
from the 200 response body of each of the following operations:- Create a subscription
- Update a subscription
- Retrieve a subscription
- List all subscriptions
- Pause a subscription
- Resume a subscription
- Cancel a subscription
- Activate a subscription
- Preview a subscription
-
In the request body of the "Create a billing document" operation, updated the description of the following fields:
-
reason_code
-
invoice_id
-
exclude_from_auto_apply_rules
-
items
>document_item_date
-
items
>name
-
November 7, 2022
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
-
For the "Create a custom object" operation, added the missing definition for the
custom_object_type
path parameter. - For the "Create a subscription" operation, corrected the request sample of the JSON payload.
-
In the 200 response body of each of the following operations:
- Retrieve a subscription plan
- List all subscription plans
-
Removed the following redundant fields:
-
plan
-
product
-
October 24, 2022
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of October 24, 2022.
- Subscriptions - Added the "Preview a subscription" operation. This operation allows you to preview the charge metrics and invoice items of a subscription.
Resolved issues
This section lists the issues that have been resolved as of October 24, 2022.
We have resolved the following issues:
-
An issue where the
state
field of the subscription item was set toexpired
when the subscription item was still active. This issue applied to the following operations:- Retrieve a subscription
- List all subscriptions
- Retrieve a subscription plan
- List all subscription plans
-
An issue that prevented you from successfully specifying the following fields on a contact using the
Create a contact
operation:
-
home_phone
-
tax_region
-
nickname
-
other_phone
-
October 17, 2022
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of October 17, 2022.
-
Subscriptions
- Made the following changes:
-
In the 200 response body of each of the following operations, added the
version
field that can be used in thefilter[]
query parameter to filter subscriptions:- Retrieve a subscription
- Update a subscription
- List all subscriptions
- Create a subscription
- Pauses a subscription
- Resume a subscription
- Cancel a subscription
- Activate a subscription
-
In the request body of the "Resume a subscription" operation, added the
resume_at
field that allows you to resume a paused subscription from the pause date.
-
In the 200 response body of each of the following operations, added the
-
Products
- In the request body of the "Update a product" operation, added the
sku
field. -
Custom Objects
- In the "List custom objects" operation, removed the
expand[]
andfilter[]
query parameters. -
In all requests, added the following header parameters to support request and response compression:
-
Content-Encoding
-
Accept-Encoding
-
Resolved issues
This section lists the issues that have been resolved as of October 17, 2022.
We have resolved the following issues:
-
A 400 error was returned when you attempted to create a subscription with an invalid
start_date
field using the Create a subscription operation -
An issue that prevented you from using the
parent_account_id
field in thefilter[]
query parameter to filter accounts using the List all accounts operation -
An incomplete response was returned when you attempted to create a subscription by specifying mutually exclusive fields,
account_id
andaccount_data
, using the Create a subscription operation
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
- Added the "Request and Response Compression" section.
-
In the 200 response body of each of the following operations:
- Retrieve a payment
- Update a payment
- List all payments
- Create a payment
- Cancel a payment
- Apply a payment
- Unapply a payment
Corrected the description of the following fields:
-
state_transitions
>canceled_time
-
gateway_state_transitions
>marked_for_submission_time
-
gateway_state_transitions
>settled_time
-
gateway_state_transitions
>submitted_time
September 30, 2022
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of September 30, 2022.
-
Prices
- Made the following changes:
-
In the following places:
- The request body of the "Create a price" operation
- The request body of the "Update a price" operation
- The response body of the "Retrieve a price" operation
- The response body of the "List all prices" operation
Made the following changes:
-
Updated the following fields as deprecated:
-
recognized_revenue_accounting_code
-
deferred_revenue_accounting_code
-
-
Moved the following fields within the
revenue
field as nested fields:-
exclude_item_booking_from_revenue_accounting
-
exclude_item_booking_from_revenue_accounting
-
-
In the response body of each of the following operations, updated the
active
field as deprecated:- Retrieve a price
- List all prices
-
In the following places:
-
Billing Document Items
- In the "List billing document items" operation, enhanced the
expand[]
query parameter to support expanding the associated billing documents. -
Subscriptions
- In the request body of the "Pause a subscription" operation, updated the processing logic of the
pause_interval
andpause_interval_count
fields. They now define the period where the subscription is paused. Previously they were used to define the period before the pause begins. -
Plans
- In the request body of the "Create a plan" operation, updated the processing logic of the
start_date
andend_date
fields. If thestart_date
andend_date
fields are not specified in the request, they are automatically set based on thestart_date
andend_date
of the parent product of this plan. -
Added the
idempotency-key
header parameter to all POST and PATCH operations -
Enhanced error handling by providing the
invalid_parameter
error code consistently in the error response for all operations.\
Resolved issues
This section lists the issues that have been resolved as of September 30, 2022.
We have resolved the following issues:
-
An unhelpful error message was returned when creating an evergreen subscription with the
auto_renew
field set totrue
using the Create a subscription operation. -
An unexpected
invalid_value
error code was returned when creating a subscription with the initial term set as theevergreen
type and withinterval_count
andinterval
specified in the request body of the Create a subscription operation. -
The
created_time
,updated_time
,created_by_id
, andupdated_by_id
fields were not returned in the response of the Create a subscription operation. - The created payment method was unexpectedly set as the default payment method for an account using the Create a payment method operation.
-
Some fields in the response were returned as
null
even though the payment method was created successfully using the Create a payment method operation. - A 500 error was returned when you were deleting a product using the Delete a product operation.
- An issue that prevented you from updating an ACH payment method using the Update a payment method operation.
-
An issue that prevented you from applying the
tax_identifier
field to an account using the Create an account operation.
Doc updates
This section lists the documentation updates that were made in this version of the API Reference.
- Added the "Idempotent Requests" section.
-
In the request body of the "Pause a subscription" operation, updated the description of the
pause_at
field to indicate that it can be used to pause a subscription on a specific date or pause from the end of the current invoice period. -
In the request body of the "Update an account" operation, removed the incorrect
currency
field. -
In the request body of the "Create an account" operation, updated the description of the
currency
field.
September 20, 2022
API updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of September 20, 2022.
-
Accounts
- Removed the
account_id
nested field from thebill_to
andsold_to
fields in the request body of each of the following operations:- Create an account
- Update an account
-
Refunds
- Made the following changes:
-
In the request body of each of the following operations, removed the
transfer_to_accounting
field:- Create a refund
- Update a refund
-
In the response schema of each of the following operations, removed the
transferred_to_accounting
field:- List all refunds
- Retrieve a refund
- Added the "Update a refund" operation.
-
In the request body of each of the following operations, removed the
-
Payments
- Made the following changes:
- Added the "Unapply a payment" operation.
-
In the request body of the "Create a payment" operation, added the
gateway_options
field.
- For all DELETE operations, we now return the 204 No Content status code for successful requests.
Resolved issues
This section lists the issues that have been resolved as of September 20, 2022.
We have resolved the following issues:
- An issue that prevented you from updating a tiered price using the Update a price operation
- An issue that prevented you from creating a refund from an invoice using the Create a refund operation
-
An issue that prevented you from creating a refund with the
statement_descriptor_phone
field specified using the Create a refund operation -
An issue that prevented you from creating a billing document with the
taxation_items
field specified using the Create a billing document operation - An issue that prevented you from creating a credit memo from an invoice using the Create a billing document operation
- An issue that prevented you from creating a credit memo while excluding the credit memo from being automatically applied to future charges using the Create a billing document operation
- An issue that prevented you from paging through subscription plans in the response for the List all subscriptions and Retrieve a subscription operations
- An incorrect response code was returned when retrieving a billing document with an unknown identifier using the Retrieve a billing document operation