Happy Business Starts Here

Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-08

  •  
  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 280, July 2020.

  •  

    • Product Rate Plans - In the response body of the “Get product rate plans” operation, made the following updates:

      • Added the following values to the productRatePlans > productRatePlanCharges > model field:
        • MultiAttributePricing
        • PreratedPerUnit
        • PreratedPricing
        • HighWatermarkVolumePricing
        • HighWatermarkTieredPricing
      • Changed the behavior of the productRatePlans > productRatePlanCharges > pricingSummary field.
    • Subscriptions - Made the following updates

      • In the request body of the following operations, added the chargeModelConfiguration nested field to the subscribeToRatePlans > chargeOverrides field:
        • Preview subscription
        • Create subscription
      • In the request body of the "Update subscription" operations, added the chargeModelConfiguration nested field to the following fields:
        • add > chargeOverrides
        • update > chargeUpdateDetails
      • In response body of the "Get subscriptions by account" operation, added the chargeModelConfiguration nested field to the subscriptions > ratePlans > ratePlanCharges field.
      • In response body of the following operations, added the chargeModelConfiguration nested field to the ratePlans > ratePlanCharges field:
        • Get subscriptions by key
        • Get subscriptions by key and version
    • Orders - Made the following updates:

      • In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, added the chargeModelData field and its nested fields to the following fields:

        • subscriptions > orderActions > addProduct > chargeOverrides > pricing
        • subscriptions > orderActions > updateProduct > chargeUpdates > pricing
        • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing
      • In the the response body of the following operations, added the chargeModelData field and its nested fields to the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > field:

        • Get an order
        • Get order metrics for evergreen subscription
      • In the response body of the following operations, added the chargeModelData field and its nested fields to the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing field:

        • Get all orders
        • Get orders by subscription owner
        • Get orders by subscription number
        • Get orders by invoice owner
      • In the request body of the following operations, changed the behavior of the subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > triggerEvent field:

        • Create order
        • Create order asynchronously

        Currently, if the triggerEvent field is not specified, the value of this field will be defaulted to the trigger event value in the product catalog.

        Previously, if this field was not specified, the value of the field would be defaulted to the trigger event value in the base subscription on which the order was created.

        This behavior change was introduced in Zuora Billing Release 279.

    • Added the rejectUnknownFields query parameter to the following operations:

      • All Actions
      • All CRUD operations that use the POST method
      • All CRUD operations that use the PUT method
    • Accounts - In the request body of the "CRUD: Update account" operation, changed the behavior of the AccountNumber field. See the description of the AccountNumber field 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 following operations, corrected the description of the mitProfileAgreedOn field:

      • Create payment method
      • Create credit card payment method
      • Create account
      • Create order
      • Create order asynchronously
      • Preview order
      • Preview order asynchronously
    • In the request body of the following operations, corrected the description of the items > skuName field:

      • Create credit memo from invoice
      • Create debit memo from invoice
      • Write off invoice
Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-16

  •  
  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 281, July 2020.

  •  

    • Orders - Made the following updates:

      • Added the returnId query parameter to the "Create order asynchronously" operation.
      • In the response body of the "Get job status and response" operation, added the following nested fields to the result field:
        • accountId
        • creditMemoIds
        • invoiceId
        • orderId
        • paymentId
        • subscriptionIds
    • Invoices - Changed the behavior of the “Write off invoice” operation. If you set the Create credit memos mirroring invoice items billing rule to Yes, you can now write off an invoice even if all its items have zero balance.

    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 payment method" operation, added the missing accountHolderInfo field and its nested fields.

    • In the request body of the "Create account" operation, added the missing accountHolderInfo nested field to the paymentMethod field.

    • In the request body of the following operations, added the missing accountHolderInfo nested field to the newAccount > paymentMethod field:

      • Create order
      • Create order asynchronously
    • In the request body of the following operations, added the missing accountHolderInfo nested field to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > paymentMethod field:

      • Preview order
      • Preview order asynchronously
    • Corrected the examples in the description of each of the following operations:

      • Get credit memos
      • Get debit memos
Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-24

  •  
  • Doc Updates

     

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

  •  

    • Removed the mistakenly documented "CRUD: Delete payment method snapshot" operation.

    • Added the 403 response schema and sample to the "Get data query job" operation.

    • Added the access control explanations to the descriptions of the following operations:

      • Get data query jobs
      • Get data query job
    • Updated the description in the "Error Handling" section.

Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-31

  •  
  • Doc Updates

     

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

  •  
    • Added the reference link to the newly published API Guides, which cover common REST API use cases.

    • Updated the description of the “Data Queries” section.