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.

September 25, 2023

API updates

This section lists operations and fields that were added, changed, or removed, as well as general API enhancements.

The following API updates are available as of September 25, 2023.

  • Prices - Made the following update:
    • Added the taxable field on the Price object. You can access this field or set this field through the following operations:
      • Create a price
      • Update a price
      • List prices
      • Retrieve a price
    • Added support for the day enum value for the recurring > interval field on the Price object for the following operations:
      • Create a price
      • Update a price
    • Enhanced the "Create a price" operation to support multiple-year intervals.
  • Orders - Made the following updates:
    • Added the "Delete an order" operation.
    • Enhanced the "Create an order" operation to support creating subscriptions for overage price.
  • Bill Runs - Added the following parameters to the "Create a bill run" operation:
    • type
    • subscription_ids
  • Subscriptions - Added the prepaid_balance and contracted_mrr fields to the returned Subscription object in the response of the following operations:
    • Retrieve a subscription
    • List subscriptions
    • List all versions of a subscription
    • Create a subscription
    • Update a subscription
    • Activate a subscription
    • Cancel a subscription
    • Resume a subscription
    • Pause a subscription

Resolved issues

This section lists the issues that have been resolved as of September 25, 2023.

We have resolved the following issues:

  • When updating a payment method , if the billing_details > address > line1 and billing_details > address > line2 fields were specified in the request, the specified values were exchanged in the response.
  • When listing payments with the expand[]=payment_applied_to parameter, you might find that debit memos were unexpectedly included in the applied_to field, whereas the payment was never applied to debit memos in reality.

September 7, 2023

API updates

This section lists operations and fields that were added, changed, or removed, as well as general API enhancements.

The following API updates are available as of September 7, 2023.

  • Payment Schedules - Added a "Payment Schedules" section that contains the following operations:
    • Create a payment schedule
    • Update a payment schedule
    • Retrieve a payment schedule
    • Cancel a payment schedule
  • Payment Schedule Items - Added a "Payment Schedule Items" section that contains the following operations:
    • Create a payment schedule item
    • Update a payment schedule item
    • Retrieve a payment schedule item
    • Cancel a payment schedule item
    • Retry a payment schedule item
    • Skip a payment schedule item
  • Accounts - Added the fax nested parameter to the bill_to and sold_to parameters in the following operations:
    • Create an account
    • Update an account
  • Subscriptions - For the expand[] query parameter of the Subscription operations, added invoice_items as a supported value to allow expanding invoice items.
  • Refunds - For the expand[] query parameter of the Refund operations, added the following supported values:
    • applied_to.payment
    • applied_to.items
  • Orders - Made the following updates to support prepaid products on the "Create an order" operation:
    • Support the term_end_day enum value for the following parameters:
      • subscriptions > subscription_plans > prices > recurring > recurring_on
      • subscriptions > add_subscription_plans > subscrption_plan > prices > recurring > recurring_on
      • subscriptions > update_subscription_plans > subscrption_plan > subscription_items > recurring > recurring_on
      • subscriptions > replace_subscription_plans > subscrption_plan > prices > recurring > recurring_on
    • Support the term_end enum value for the following parameters:
      • subscriptions > subscription_plans > prices > recurring > alignment_behavior
      • subscriptions > add_subscription_plans > subscrption_plan > prices > recurring > alignment_behavior
      • subscriptions > update_subscription_plans > subscrption_plan > subscription_items > recurring > alignment_behavior
      • subscriptions > replace_subscription_plans > subscrption_plan > prices > recurring > alignment_behavior
  • We have enhanced custom_fields to allow being defined as any data type on all objects. Previously it could only be defined as the string type.

Resolved issues

This section lists the issues that have been resolved as of September 7, 2023.

We have resolved the following issues:

  • When creating an order with custom fields on the Order Action object specified, the request succeeded but the Order Action custom fields were not populated. We have resolved this issue to support custom fields on the Order Action object.
  • When creating an order with the state parameter set to draft , an error would occur indicating that processing_options was not supported even if you did not specify the processing_option parameter.

August 22, 2023

API updates

This section lists operations and fields that were added, changed, or removed, as well as general API enhancements.

The following API updates are available as of August 22, 2023.

  • Bill Runs - Made the following updates:
    • In the request body of the "Create a bill run" operation, added the name parameter.
    • In the 200 response body of the following operations, added the name field to the returned Bill Run object:
      • Create a bill run
      • Retrieve a bill run
      • List bill runs
  • Invoices - In the 200 response body of the following operations, added the sold_to_id and sold_to fields to the returned Invoice object:
    • Create an invoice
    • Retrieve an invoice
    • List invoices
    • Update an invoice
    • Reverse an invoice
    • Post an invoice
    • Unpost an invoice
    • Pay an invoice
    • Cancel an invoice
  • Subscriptions - In the 200 response body of the following operations, added the sold_to_id and sold_to fields to the returned Subscription object:
    • Create a subscription
    • Retrieve a subscription
    • List subscriptions
    • Update a subscription
    • Pause a subscription
    • Resume a subscription
    • Cancel a subscription
    • Activate a subscription
    • List all versions of a subscription
  • Taxation Items - In the request body of the "Create a taxation item" operation, updated the invoice_item_id parameter from optional to required.

Resolved issues

This section lists the issues that have been resolved as of August 22, 2023.

We have resolved the following issue:

  • When creating termed subscriptions using the Create an order or Create a subscription operation without the renewal_term parameter specified, you might receive misleading API error messages. We have enhanced the error handling for such a case to clearly indicate that the renewal_term field is required when initial_term.type is termed .

May 31, 2023

API updates

This section lists operations and fields that were added, changed, or removed, as well as general API enhancements.

The following API updates are available as of May 31, 2023.

Enhancements for the Prepaid Drawdown feature

  • Prices - Added prepayment and drawdown fields to the Price object. The following operations are affected:
    • Create a price
    • List prices
    • Retrieve a price
    • Update a price
  • Subscription Items - In the response body of the "List subscription items" operation, added the prepayment and drawdown nested fields to the price field.

Other enhancents

  • Prices - Added the stacked_discount and revenue_recognition_rule fields to the Price object to support the stacked discount charges. The following operations are affected:
    • Create a price
    • Update a price
    • List prices
    • Retrieve a price
  • Refunds - In the request body of the "Create a refund" operation, added the credit_memo field to support creating a refund for a credit memo.
  • Subscriptions - Made the following updates:
    • For the expand[] query parameter of the "List all versions of a subscription" operation, added order as a supported value to allow expanding on orders.
    • For the expand[] query parameter of all Subscriptions operations, added invoice_owner_account as a supported value to support expanding on invoice owner account details.
  • Payment Methods - Made the following updates:
    • Added the apple_pay and google_pay fields to the Payment Method object. The following operations are affected:
      • Create a payment method
      • Retrieve a payment method
      • List payment methods
      • Update a payment method
      • Verify a payment method
    • Added the cc_ref > card field to the Payment Method object. The following operations are affected:
      • Create a payment method
      • Retrieve a payment method
      • List payment methods
      • Update a payment method
      • Verify a payment method
  • Orders - In the response body of all Orders operations, added the next_page nested field to the subscriptions > actions > subscription_plans field.
  • Usage Records - For the "Create a usage record" operation, added subscription_number as a filterable field for the filter[] query parameter. See Filter Lists for more information.
  • Add support for the IN operator for the filter[] query parameter to allow filtering on one field with multiple values. For more information about how to use this operator, see Filter Lists .
  • The default page_size for all List endpoints are now updated to 30. Previously, it was not consistent across the objects.
  • The maximum page_size value has been updated to 99. Previously, up to 50 records were allowed.
  • Added support for specifying the fields of the top-level resource without specifying the object name. Previously, it was required that you specify the top level object name such as account.fields[] when submitting the "List accounts" request. Either account.fields[] or fields[] are now allowed to achieve the same result.

Resolved issues

This section lists the issues that have been resolved as of May 31, 2023.

We have resolved the following issues:

  • The account_number field was not supported as the path parameter for the "Preview an account" operation.
  • When fetching a tiered with overage price or subscription item, an empty tier was returned in the tier list.

April 26, 2023

API updates

This section lists operations and fields that were added, changed, or removed, as well as general API enhancements.

The following API updates are available as of April 26, 2023.

  • Subscriptions - Made the following updates:
    • Added the "List all versions of a subscription" operation.
    • In the request body of the "Cancel a subscription" operation, added the following fields to support the canceling a subscription with write-off use case:
      • write_off
      • write_off_behavior
    • In the request body of the "Create a subscription" operation, added the subscription_plans > plan_number field.
    • In the request body of the "Update a subscription" operation, added the following fields:
      • add_subscription_plans > subscription_plan > plan_number
      • replace_subscription_plans > subscription_plan > plan_number
  • Orders - In the request body of the "Create an order" operation, added the following fields:
    • subscriptions > subscription_plans > plan_number
    • subscriptions > add_subscription_plans > plan_number
    • subscriptions > replace_subscription_plans > subscription_plans > plan_number
  • Plans - Made the following updates:
    • In the request body of each of the following operations, added the plan_number field:
      • Create a plan
      • Update a plan
    • In the 200 response body of each of the following operations, added the plan_number field:
      • Retrieve a plan
      • List plans
  • Added the following headers to all operations:
    • zuora-org-id
    • zuora-return-nested-orgs-data

April 18, 2023

API updates

This section lists operations and fields that were added, changed, or removed, as well as general API enhancements.

The following API updates are available as of April 18, 2023.

  • Added the <object>.fields[] query parameter to all operations to support returning only the intended fields in the response.
  • Fulfillments - Added the "Fulfillments" section that contains the following operations:
    • Create a fulfillment
    • Create fulfillments
    • Retrieve a fulfillment
    • List fulfillments
    • Update a fulfillment
    • Delete a fulfillment
  • Fulfillment Items - Added the "Fulfillment Items" section that contains the following operations:
    • Create a fulfillment item
    • Create fulfillment items
    • Retrieve a fulfillment item
    • List fulfillment items
    • Update a fulfillment item
    • Delete a fulfillment item
  • Bill Run Previews - Added the "Bill Run Previews" section that contains the following operations:
    • Create a bill run preview
    • Retrieve a bill run preview
  • Query Runs - Added the "Query Runs" section that contains the following operations:
    • Create a query run
    • Retrieve a query run
    • Cancel a query run
  • Orders - Added the following operations:
    • Activate an order
    • Cancel an order
  • Payment Methods - Added the following operations:
    • Create a payment authorization
    • Cancel a payment authorization
  • Accounts - Made the following changes:
    • Added support for the account number to be used in the account_id path parameter:
      • Retrieve an account
      • Update an account
      • Delete an account
      • Generate billing document for an account
    • Added the following supported values for the expand[] query parameter on the Account object:
      • credit_memos
      • debit_memos
      • invoices
  • Invoices - Added support for the invoice number to be used in the invoice_id path parameter for the following operations:
    • Update an invoice
    • Post an invoice
    • Unpost an invoice

    Previously, only the invoice ID was allowed.

  • Payment Runs - Added summary as the supported value for the expand[] parameter to retrieve the payment run summary information.
  • Deprecated the balance field on the following objects and replaced it with the remaining_balance field:
    • Billing Document
    • Invoice
    • Credit Memo
    • Debit Memo

Resolved issues

This section lists the issues that have been resolved as of April 18, 2023.

We have resolved the following issues:

  • If there was incorrect user or tenant permission when using the Update a price operation to update a price, the internal server error was thrown.
  • When creating a contact or updating a contact , the specified nickname field was ignored.
  • When you attempted to make API calls without the Orders feature enabled for your tenant, an unclear error message was returned. We have enhanced error handling for this case.

March 13, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

The following API updates are available as of March 13, 2023.

Enhancements for the Flexible Billing feature

Made the following changes to support the Flexible Billing feature:

  • Credit Memos - Added the following fields:
    • bill_to_id
    • bill_to (expandable)
    • billing_document_settings

    To the Credit Memo object in the response body of the following operations:

    • Retrieve a credit memo
    • List all credit memos
    • Create a credit memo
    • Update a credit memo
    • Apply a credit memo
    • Unapply a credit memo
    • Unpost a credit memo
    • Post a credit memo
    • Cancel a credit memo
  • Debit Memos - Added the following fields:
    • bill_to_id
    • bill_to (expandable)
    • billing_document_settings
    • payment_terms

    To the Debit Memo object in the response body of the following operations:

    • Retrieve a debit memo
    • List debit memos
    • Create a debit memo
    • Update a debit memo
    • Cancel a debit memo
    • Post a debit memo
    • Unpost a debit memo
    • Pay a debit memo
  • Invoices - Added the following fields:
    • bill_to_id
    • bill_to (expandable)
    • billing_document_settings
    • payment_terms

    To the Invoice object in the response body of the following operations:

    • Retrieve an invoice
    • List invoices
    • Create an invoice
    • Update an invoice
    • Reverse an invoice
    • Post an invoice
    • Cancel an invoice
    • Write off an invoice
  • Subscriptions - Made the following changes:
    • Added the following fields:
      • bill_to_id
      • billing_document_settings
      • payment_terms

      To the request body of the following operations:

      • Create a subscription
      • Preview a subscription
      • Update a subscription
    • Added the following fields:
      • bill_to_id
      • bill_to (expandable and read-only)
      • billing_document_settings
      • payment_terms

      To the Subscription object in the response body of the following operations:

      • Retrieve a subscription
      • List subscriptions
      • Create a subscription
      • Update a subscription
      • Pause a subscription
      • Resume a subscription
      • Cancel a subscription
      • Activate a subscription
      • Cancel a subscription

    Note that these fields are only applicable for new subscriptions, or updating a subscription when changing terms, invoice owners, or renewals.

  • Orders - Made the following changes:
    • Added the following nested fields:
      • subscriptions > bill_to_id
      • subscriptions > billing_document_settings
      • subscriptions > payment_terms

      To the request body of the following operations:

      • Create an order
      • Preview an order
    • Added the following nested fields:
      • subscriptions > bill_to_id
      • subscriptions > bill_to (expandable and read-only)
      • subscriptions > billing_document_settings
      • subscriptions > payment_terms

      To the Order object in the response body of the following operations:

      • List orders
      • Retrieve an order
      • Create an order
      • Preview an order

    Note that these fields are only applicable for new subscriptions, or updating a subscription when changing terms, invoice owners, or renewals.

Other API enhancements

  • Payment Runs - Added the "Payment Runs" section that contains the following operations:
    • Create a payment run
    • List payment runs
    • Retrieve a payment run
    • Update a payment run
    • Delete a payment run
  • Subscriptions - Added the following operation:
    • Preview an existing subscription
    • List subscription items
  • Invoices - Made the following updates:
    • Added the canceled_time supported value to the state_transitions field of the Invoice object.
    • Changed the following state field enum values for the Invoice object:
      • Updated open to posted
      • Updated uncollectible to canceled
  • Debit Memos and Credit Memos - Made the following value changes for the state field for the Credit Memo and Debit Memo objects:
    • Updated open to posted
    • Updated uncollectible to canceled
  • Payment Methods - Added other to the type field enum values of the Payment Method object to indicate external payment methods.

Resolved issues

This section lists the issues that have been resolved as of March 13, 2023.

We have resolved the following issue:

  • The description on an account could not be successfully updated when using the Update an account operation.
  • When you were using the Uncancel a subscription operation, an unexpected error would be thrown if the cancellation was created within around 2 seconds of the subscription creation. We have resolved this issue by ensuring that the subscription can be successfully updated and enhancing the error message.

Doc updates

This section lists the documentation updates that were made in this version of the API Reference.

  • Added all error responses to all operations.

March 7, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

The following API updates are available as of March 7, 2023.

  • Invoices - Made the following updates:
    • Added the following operations:
      • Email an invoice
      • Write off an invoice
    • In the "List invoice items" operation, added the line_item expand[] parameter to support expanding order line items on invoice items.
  • Orders - Made the following updates:
    • In the request body of the "Create an order" operation, added the subscription > term nested field to support changing terms and conditions in an order.
    • In the following operations, added the account and line_items.invoice_items expand[] parameters:
      • List orders
      • Create an order
      • Retrieve an order
  • Usage Records - In the following operations, added the account expand[] parameter to support expanding account data on usage records:
    • Create a usage record
    • Retrieve a usage record
    • List usage records
    • Update a usage record
  • Accounts - In the following operations, added the usage_records expand[] parameter to support expanding usage records on accounts:
    • Create an account
    • List all accounts
    • Retrieve an account
    • Update an account

Resolved issues

This section lists the issues that have been resolved as of March 7, 2023.

We have resolved the following issue:

  • An unexpected error was thrown if you attempted to create a refund for an existing payment using Create a refund when the Invoice Settlement feature was not enabled.

February 27, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

The following API updates are available as of February 27, 2023.

  • Bill Runs - Added the "Bill Runs" section with the following operations:
    • Create a bill run
    • Retrieve a bill run
    • List bill runs
    • Update a bill run
    • Delete a bill run
    • Post a bill run
    • Cancel a bill run
  • Taxation Items - Added the "Taxation Items" section with the following operations:
    • Create a taxation item
    • Retrieve a taxation item
    • List taxation items
    • Update a taxation item
    • Delete a taxation item
  • Usage Records - Added the "Usage Records" section with the following operations:
    • Create a usage record
    • Retrieve a usage record
    • List usage records
    • Update a usage record
    • Delete a usage record
  • Invoices - Added the following operations:
    • Update an invoice
    • Reverse an invoice
    • Pay an invoice
    • Delete an invoice
  • Debit Memos - Added the following operations:
    • Update a debit memo
    • Pay a debit memo
    • Cancel a debit memo
    • Delete a debit memo
  • Credit Memos - Made the following updates:
    • Added the following operations:
      • Update a credit memo
      • Delete a credit memo
    • In the billing_documents > items nested field of the request body of the "Apply a credit memo" operation, added the following fields:
      • credit_memo_item_id
      • credit_memo_taxation_item_id
  • Payment Methods - Added the "Scrub a payment method" operation.

February 6, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

The following API updates are available as of February 6, 2023.

  • Orders - Made the following updates:
    • Added the "List orders" operation.
    • In the subscription field in the request body of the "Create an order" operation, added the replace_subscription_plans nested field.
  • Subscriptions - In the request body of the "Update a subscription" operation, added the replace_subscription_plans field.
  • Invoices - Added the following operations:
    • List invoice items
    • Post an invoice
    • Unpost an invoice
    • Cancel an invoice
  • Debit Memos - Added the following operations:
    • List debit memo items
    • Post a debit memo
    • Unpost a debit memo
  • Payment Methods - Added the "Verify a payment method" operation.
  • Refunds - Added the following operations:
    • Delete a refund
    • Cancel a refund
  • For all GET methods that retrieve a single object, added the page_size query parameter.

Resolved issues

This section lists the issues that have been resolved as of February 6, 2023.

We have resolved the following issues:

Doc updates

This section lists the documentation updates that were made in this version of the API Reference.

  • Added the request and response payload examples to each of the following operations:
    • Create an order
    • Preview an order

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
  • 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 to nickname :
      • Create a contact
      • Update a contact
    • In the 200 response of each of the following operations, renamed the nick_name field to nickname :
      • 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 to verified 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 by end_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 to true 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 to nick_name :
    • Create a contact
    • Update a contact
    • In the 200 response of each of the following operations, renamed the nickname field to nick_name :
    • Create a contact
    • Update a contact
    • Retrieve a contact
    • List all contacts
  • 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 the gateway_id field instead of payment_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 to expired 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 the filter[] 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.
  • 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[] and filter[] 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 the filter[] 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 and account_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
  • 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  and  pause_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  and  end_date  fields. If the  start_date  and  end_date  fields are not specified in the request, they are automatically set based on the  start_date  and  end_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 to  true  using the  Create a subscription  operation.
  • An unexpected  invalid_value  error code was returned when creating a subscription with the initial term set as the  evergreen  type and with  interval_count  and  interval  specified in the request body of the  Create a subscription  operation.
  • The  created_time ,  updated_time ,  created_by_id , and  updated_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 the bill_to and sold_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.
  • 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