Zuora Documentation

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!

 

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.