API Changelog

[Yingying]

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!

 

2019-01-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 236, January 2019.

• Accounts - In the “Create account” operation, added the documentDate field to the request body.

• Subscriptions - In the following operations, added the documentDate field to the request body:

  • Create subscription
  • Update subscription
  • Renew subscription
  • Cancel subscription
  • Resume subscription
  • Suspend subscription

• Invoices - In the request body of the “Write off invoice” operation, added the following fields and support for custom fields:

  • comment
  • items and its nested fields
  • reasonCode

• Product Rate Plans - In the response body of the “Get product rate plans” operation, added the following nested fields to the productRatePlans > productRatePlanCharges > financeInformation field:

  • contractAssetAccountingCode
  • contractAssetAccountingCodeType
  • contractLiabilityAccountingCode
  • contractLiabilityAccountingCodeType
  • adjustmentLiabilityAccountingCode
  • adjustmentLiabilityAccountingCodeType
  • unbilledReceivablesAccountingCode
  • unbilledReceivablesAccountingCodeType
  • adjustmentRevenueAccountingCode
  • adjustmentRevenueAccountingCodeType
  • contractRecognizedRevenueAccountingCode
  • contractRecognizedRevenueAccountingCodeType

• Catalog - Made the following updates:

  • In the “Get catalog” operation, changed the behavior of the products > productRatePlans field in the response body.
  • In the “Get product” operation, changed the behavior of the productRatePlans field in the response body.

  This behavior change is available only when you set the zuora-versionrequest header to 230.0 or later. See the descriptions of the productRatePlans fields to find out details about the latest behavior.

• Bill Run - Changed the behavior of the “CRUD: Create bill run” operation. If more than 500 bill runs created by using this operation are in Pending status, no more bill runs can be created by using this operation.

• Payments - Changed the behavior of the following operations. If you have the Invoice Settlement feature enabled, payments applied to credit balance cannot be canceled or deleted.

  • Cancel payment
  • Delete payment

• Refunds - Changed the behavior of the following operations. If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be canceled or deleted.

  • Cancel refund
  • Delete refund

 

Doc Updates

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

• In the “Amend” action, corrected the descriptions of the DestinationInvoiceOwnerId and DestinationAccountId fields in the request body.

• In the "Suspend subscription” and “Resume subscription” operations, removed the notes about the limitation on using these operations with Order Metrics.

• In the “Preview order” operation, added the missing taxInfo nested field to the previewAccountInfo field in the request body.

• In the response bodies of the following operations, noted when certain fields are not applicable in the order > subscriptions > orderActions > suspend field:

  • Get an order
  • Get order metrics for evergreen subscription

  Those fields include:

  • suspendPolicy
  • suspendPeriods
  • suspendPeriodsType
  • suspendSpecificDate

• In the response bodies of the following operations, noted when certain fields are not applicable in the order > subscriptions > orderActions > resume field:

  • Get an order
  • Get order metrics for evergreen subscription

  Those fields include:

  • resumePolicy
  • resumePeriods
  • resumePeriodsType
  • resumeSpecificDate
  • extendsTerm

• In the response bodies of the following operations, noted when certain fields are not applicable in the orders > subscriptions > orderActions > suspend field:

  • Get all orders
  • Get orders by subscription owner
  • Get orders by subscription number
  • Get orders by invoice owner

  Those fields include:

  • suspendPolicy
  • suspendPeriods
  • suspendPeriodsType
  • suspendSpecificDate

• In the response bodies of the following operations, noted when certain fields are not applicable in the orders > subscriptions > orderActions > resume field:

  • Get all orders
  • Get orders by subscription owner
  • Get orders by subscription number
  • Get orders by invoice owner

  Those fields include:

  • resumePolicy
  • resumePeriods
  • resumePeriodsType
  • resumeSpecificDate
  • extendsTerm

• In all relevant operations, changed the name of the Real-Time Usage Rating feature to Active Rating, and updated all related reference links.

[Yingying]

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!

2019-01-22

API Updates

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 237, January 2019.

• Subscriptions - In the following operations, added the documentDate field to the request body:

  • creditMemo > creditMemoItems
  • invoicceItems

• Product Rate Plans - In the response body of the “Get product rate plans” operation, added the following nested fields to the productRatePlans > productRatePlanCharges > financeInformation field:

  • revRecCode
  • revRecTriggerCondition

• Catalog - Made the following updates:

  • In the response body of the “Get catalog” operation, changed the behavior of the products > productRatePlans field.
  • In the response body of the “Get product” operation, changed the behavior of the productRatePlans field.

  This behavior change is available only when you set the zuora-versionrequest header to 230.0 or later. See the descriptions of the productRatePlans fields to find out details about the latest behavior.

 

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 debit memo from charge” operation, added the following missing fields to the charges field:

  • serviceStartDate
  • serviceEndDate

• In the “Preview order” operation, added the missing description for the previewOptions > previewTypes field in the request body.

• In the “Create order” operation, corrected a possible value of the subscriptions > orderActions > type field in the request body.

  Previously, the value Suspend was incorrectly listed as Subspend.

[Yingying]

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!

2019-02-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 238, February 2019.

• Orders - Made the following updates:
  • In both the “Create order” and “Preview order” operations, added the priceChangeOption field to the following fields in the request body:
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount

 

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 payment” operation, removed the referenceId field.
• In the source YAML file, duplicated the DiscountPricingOverride reference object as a new reference object called PostOrderDiscountPricingOverride that is used in the request body of the following operations:
  • Create order
  • Preview order
• In the source YAML file, duplicated the DiscountPricingUpdate reference object as a new reference object called PostOrderDiscountPricingUpdate that is used in the request body of the following operations:
  • Create order
  • Preview order

2019-02-12

API Updates

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 238, February 2019.

• Accounts - Made the following updates:

  • In the request body of the “Generate billing documents by amount” operation, added the following fields:
    • autoRenew
    • chargeTypeToExclude
  • In the response body of the “Create account” operation, added the following fields:
    • billToContactId
    • soldToContactId

 

Doc Updates

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

• In the response body of the “Get account” operation, corrected the descriptions of the following fields:

  • billToContact > country
  • billToContact > state
  • soldToContact > country
  • soldToContact > state

• In the response body of the “Get account summary” operation, corrected the descriptions of the following fields:

  • billToContact > country
  • billToContact > state
  • soldToContact > country
  • soldToContact > state

• In the request body of the “Create credit card payment method” operation, removed “required” from the following nested fields of the cardHolderInfo field. However, if you do not specify the accountKey field in the request body, the cardHolderName field is still required.

  • cardHolderName
  • City
  • State
  • zipCode
  • country

• Changed the URL of the source YAML file. See this post for more information.

• In the request body of the “Update payment” operation, added the referenceId field. However, as of Zuora Release 238, this field is not available.

[Yingying]

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!

2019-02-27

API Updates

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 239, February 2019.

• Accounts - In the request body of the “Create account” operation, changed the behavior of the runBilling field to match the documentation.

  Previously, invoices were also generated even if runBilling is set to false. Credit memos were also generated if the Invoice Settlement feature was enabled.

2019-02-20

API Updates

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 239, February 2019.

• Payments - In the request body of the “Update payment” operation, added the referenceId field.

• OAuth - In the “Generate an OAuth token” operation, the client_secret request body field now has a maximum supported length of 42 characters.

  When you create an OAuth client using the Zuora UI, the Client Secret is 38 to 42 characters long. Previously, Client Secrets were always 20 characters long. You can continue to use existing Client Secrets without modification.

The following items are API updates specific to enhancements to the Invoice Item Settlement feature:

• Invoices - Made the following updates:

  • Added a new operation “Get taxation items of invoice item”.
  • In the response body of the “Get invoice items” operation, added the balance and taxationItems nested fields to the invoiceItems field.

• Credit Memos - Made the following updates:

  • Added a new operation “Get taxation items of debit memo item”.
  • In the “Get credit memo items” operation:
    • Added the zuora-version request header.
    • Added the taxationItems nested fields to the items response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
    • Changed the behavior of the items > creditTaxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.
  • In the “Get credit memo item” operation:
    • Added the zuora-version request header.
    • Added the taxationItems response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
    • Changed the behavior of the creditTaxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.

• Debit Memos - Made the following updates:

  • Added a new operation called “Get taxation items of debit memo item”.
  • In the “Get debit memo items” operation:
    • Added the zuora-version request header.
    • Added the taxationItems nested field to the items response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
    • Changed the behavior of the items > taxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.
  • In the “Get debit memo item” operation:
    • Added the zuora-version request header.
    • Added the taxationItems response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
    • Changed the behavior of the taxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.

Doc Updates

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

• In the “Subscribe” action, made the following updates:

  • Added the AccountId nested field to the subscribes > Account request body field.
  • Removed the following nested fields from the subscribes > Account request body field:
    • Balance
    • BillToId
    • CreatedById
    • CreatedDate
    • CreditBalance
    • SoldToId
    • Status
    • UpdatedById
    • UpdatedDate
  • Improved the request and response samples.

• In the “Generate an OAuth token” operation, documented the supported length of the client_id request body field.

• In the “API Versions” section, added the following fields to the “Minor Version History” table:

  • creditTaxItems
  • taxItems
  • taxationItems
• In the request body of the “Generate RSA signature” operation, removed the redundant “zuora.com/apps/PublicHostedPageLite.do if you are on the API Sandbox environment.” from the description of the uri field.

[Yingying]

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!

2019-03-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 240, March 2019.

• Payment Methods - Made the following updates:
  • In the request body of the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the following fields:
    • IdentityNumber
    • IsCompany
    • CompanyName
  • In the response body of the “CRUD: Get payment method” operation, added the following fields:
    • IdentityNumber
    • IsCompany
    • CompanyName

 

Doc Updates

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

• In the description of the Actions section, clarified that actions do not support the Invoice Settlement feature and the Orders feature. Also clarified this in the description of the “Query” action.

[Yingying]

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!

2019-03-13

API Updates

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

The following API updates are available as of Zuora Release 240, March 2019.

• Payment Methods - Made the following updates:

  • In the request body of the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the following enum values to the BankTransferType field:
    • Autogiro
    • Betalingsservice
  • In the response body of the “CRUD: Get payment method” operation, added the following enum values to the BankTransferType field:
    • Autogiro
    • Betalingsservice

• Payment Method Snapshots - In the response body of the “CRUD: Get payment method snapshot” operation, added the following enum values to the BankTransferType field:
  - Autogiro
  - Betalingsservice

The following API updates are available as of Zuora Release 241, March 2019.

• Payment Methods - Made the following updates:
  • Added the following operations:
    • Create stored credential profile
    • Get stored credential profiles
    • Cancel stored credential profile
    • Expire stored credential profile
  • In the request body of the “Create credit card payment method” operation, added the following fields:
    • mitConsentAgreementRef
    • mitConsentAgreementSrc
    • mitProfileAction
    • mitProfileType

 

Doc Updates

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

• In the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the missing BankTransferType field to the request body.

• In the “Get subscriptions by key” operation, corrected the description of the charge-detail query parameter.

[Yingying]

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!

2019-03-20

API Updates

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 242, March 2019.

• Orders - Made the following updates:

  • In the following operations, added the includeUnits field to the order (or orders) > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageOverage field in the response body:

    • Get an order
    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
    • Get order metrics for evergreen subscription

  • In the following operations, added the priceChangeOption field to the order (or orders) > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount field in the response body:

    • Get an order
    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
    • Get order metrics for evergreen subscription

  • In the following operations, added the priceChangeOption field to the order (or orders) > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount field in the response body:

    • Get an order
    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
    • Get order metrics for evergreen subscription

• Payment Methods - Made the following updates:

  • In the “Create payment method” operation, made the following updates in the request body:

    • Added the possible value CreditCard to the type field.
    • Added the following fields:
      • cardHolderInfo
      • cardNumber
      • cardType
      • expirationMonth
      • expirationYear
      • mitConsentAgreementRef
      • mitConsentAgreementSrc
      • mitNetworkTransactionId
      • mitProfileAction
      • mitProfileType
      • securityCode

  • In the “Create credit card payment method” operation, made the following updates in the request body:

    • Added the possible value Persist to the mitProfileAction field.
    • Added the mitNetworkTransactionId field.

  • In the “Create stored credential profile” operation, added the action field in the request body.

  • In the following operations, updated the description of the IPAddress field in the request body (or the response body) to clarify that the field has now been supported by the WorldPay payment gateway integration:

    • CRUD: Create payment method
    • CRUD: Update payment method
    • CRUD: Get payment method

• Refunds - In the request body of the “Update refund” operation, added the referenceId field.

 

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 account” operation, added reference information to the description of the creditCard > cardType field.

• In the request body of the “Subscribe” action, added reference information to the description of the subscribes > PaymentMethod > CreditCardType field.

• In the request body of the “Create credit card payment method” operation, added reference information to the description of the creditCardType field.

• In the request body of the following operations, added reference information to the description of the CreditCardType field:

  • CRUD: Create payment method
  • CRUD: Update payment method

• In the response body of the “Get account summary” operation, added reference information to the description of the basicInfo > defaultPaymentMethod > creditCardType field.

• In the response body of the “Get credit card payment methods for account” operation, added reference information to the description of the creditCards > cardType field.

• In the response body of the “CRUD: Get payment method” operations, added reference information to the description of the CreditCardType field.

• In the request body of the “Create stored credential profile” operation, clarified the description of the status field.

• Added a new section Link Queries containing the following operations:

  • Submit Link query
  • Get Link query jobs
  • Get Link query job
  • Cancel Link query job

• In the source YAML file, replaced the PostOrderDiscountPricingOverride reference object by the DiscountPricingOverride reference object. This change affects the following operations:

  • Create order
  • Preview order

• In the source YAML file, replaced the PostOrderDiscountPricingUpdate reference object by the DiscountPricingUpdate reference object. This change affects the following operations:

  • Create order
  • Preview order

• In the source YAML file, replaced the UsageOveragePricingUpdatePostOrder reference object by the UsageOveragePricingUpdate reference object. This change affects the following operations:

  • Create order
  • Preview order

• In the source YAML file, replaced the cardHolderInfo field in the POSTPaymentMethodType reference object by a new reference object called CreatePaymentMethodCardholderInfo. This change affects the “Create credit card payment method” operation.

[Yingying]

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!

2019-03-27

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 account” and “Renew subscription” operations, made the following updates:

  • Removed the unsupported version 196.0 from the description of the invoiceCollect field.
  • Corrected the data type of the collect field from string to boolean and updated the prerequisite of this field to "The invoice or runBilling field must be true".

• In the request body of the subscription-related operations listed below, made the following updates:

  • Removed the unsupported version 196.0 from the description of the invoiceCollect field.
  • Corrected the prerequisite of this field to "The invoice or runBilling field must be true".

  The following operations are affected:

  • Create subscription
  • Update subscription
  • Resume subscription
  • Suspend subscription
  • Cancel subscription

• In the Zuora Object Model section, clarified that the API name of the Billing Run object is BillingRun in Zuora Link.

• In the request body of the “Submit Link query” operation, made the following updates:

  • Removed the queryType field.
  • Changed the description of the output > target field.

[Yingying]

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!

2019-04-10

Doc Updates

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

• Changed “customer-initiated” to “cardholder-initiated” in the following locations:

  • The mitProfileAction field in the request body of the “Create payment method” operation.
  • The mitProfileAction field in the request body of the “Create credit card payment method” operation.
  • The action and status fields in the request body of the “Create stored credential profile” operation.

• In the request body of the “CRUD: Create Import” operation, removed the unsupported import type MPU from the enum values of the ImportType field.

[Yingying]

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!

2019-04-18

API Updates

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

The following API updates are available as of Zuora Release 243, April 2019.

• Payment Methods - In the request body of the “Create payment method” operation, added the possible value ACH to the type field.

The following items are API updates specific to enhancements to the prefix and numbing configuration for billing documents. These API updates are also available as of Zuora Release 243, April 2019.

• Sequence Sets - Added a new resource called “Sequence Sets”, with the following new operations:

  • Create sequence set
  • Get sequence sets
  • Update sequence set
  • Get sequence set
  • Delete sequence set

• Accounts - In the request body of the following operations, added the sequenceSetId field:

  • Create account
  • Update account

• Orders - In the request body of the following operations, added the sequenceSetId nested field to the newAccount field:

  • Create order
  • Create order asynchronously

 

Doc Updates

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

• In the request body of the “Subscribe” action, corrected the name of the subscribes > Account > Id field. Previously, the name of this field was documented as AccountId.