Happy Business Starts Here

Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-03-11

     

  • 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 296, March 2021.

  •  

    The Invoice Settlement feature is generally available as of this release. Changed all the Limited Availability notes to General Availability notes for:

    • All the operations specific to Invoice Settlement
    • All the fields related to Invoice Settlement in other operations

     

  • Doc Updates

  •  

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

  •  

    • In the response body of each of the "Get a workflow by ID" and "Run a workflow" operations, corrected the statuses and added the description for each status.
    • Added a note in the description of the "Event Triggers" section.
    • In the "Notifications" section, added references to Communication Profiles Settings pages in the Knowledge Center.
    • Added a note in the description of each of the following operations:
      • Create a notification definition
      • Query notification definitions
      • Update a notification definition
      • Get a notification definition
      • Delete a notification definition
      • Create an email template
      • Query email templates
      • Update an email template
      • Get an email template
      • Delete an email template

    •  
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-03-19

     

  • 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 297, March 2021.

  •  

    • Workflows - Added an operation called "Rerun a task by ID".

    • Custom Object Jobs - Added a resource called "Custom Object Jobs", with the following operations:

      • Submit custom object bulk job
      • Get all custom object bulk jobs
      • Get custom object bulk job
      • Upload file for custom object bulk job
      • Get all errors for a custom object bulk job
    • Subscriptions - In the request body of the "Update subscription custom fields of a specified subscription version" operation, added the ratePlans > charges > chargeId field.

    • Orders - Previously, a suspended subscription could not be resumed on a specific date through the "Create order" operation. This issue has now been resolved. The data format of the subscriptions > orderActions > resume > resumeSpecificDate field has been corrected from string<dateTime> to string<date> in the request body of the "Create order" operation.

     

  • Doc Updates

     

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

  •  

    • In the request body of the "CRUD: Get rate plan charge" operation, added the missing RolloverBalance field.
    • In the query parameter lists of the "Get callout notification histories" and "Get email notification histories" operations, added a note in the description of each of the following parameters:
      • objectId
      • failedOnly
      • eventCategory
    • In the request body of the "Update subscription custom fields of a specified subscription version" operation, updated the description for the ratePlans > charges > chargeNumber field.
  •  
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-03-26

  •  
  • Doc Updates

     

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

  •  

    • In the response body of the "Amend" action, noted in the description of the results > InvoiceDatas field that this array contains only one invoice.
    • In the request body of the "Update payment method" operation, updated the description for the securityCode field.
    • In the description of the “Get invoice files” operation, clarified the behavior of this operation.
  •  
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-04-02

  •  
  • API Updates

     

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

  •  

    • The support for creating custom payment runs is generally available. Removed all the Early Adopter enablement notes for the following operations:
      • Create payment run
      • Get payment run summary
      • Get payment run data

     

  • Doc Updates

     

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

  •  

    • Removed a limitation from the description of the "Create an event trigger" operation.

    • Added the limits of orders allowed on a subscription in the following operations:

      • Create order
      • Create order asynchronously
      • Preview order
      • Preview order asynchronously
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-04-15

  •  
  • 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 299, April 2021.

  •  

    • Payment Methods - Made the following updates:

      • In the description of the “Create payment method” operation and the description of the type field in the request body, added information about the following newly supported payment methods:
        • Direct Entry AU (Becs)
        • Direct Debit NZ (Becsnz)
        • Pre-Authorized Debit (PAD)
      • In the request body of each of the following operations, added a field called currencyCode:
        • Create payment method
        • Update payment method
        • Verify payment method
    • Workflows - Added an operation called "Update a workflow definition by ID".

    • Invoices - Changed the behavior of the "Upload file for invoice" operation. To use this operation, you must enable the Modify Invoice billing permission.

    • Credit Memos - Changed the behavior of the "Upload file for credit memo" operation. To use this operation, you must enable the Modify Credit Memo billing permission.

    • Debit Memos - Changed the behavior of the "Upload file for debit memo" operation. To use this operation, you must enable the Modify Debit Memo billing permission.

     

  • Doc Updates

     

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

  •  

    • Made the following updates to the “Create payment” operation:

      • In the description of the operation, elaborated the scenarios.
      • In the request body, updated the description of each of the authTransactionId and gatewayOrderId fields.
    • Updated the description of the "Create authorization" operation.

    • Made the following updates to enhance the field description for each of the ratingGroup fields in the Orders APIs.

      • In the request body of each of the following operations:

        • Create order
        • Create order asynchronously
        • Preview order
        • Preview order asynchronously

        Enhanced the description for each of the following fields:

        • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > ratingGroup
        • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTiered > ratingGroup
        • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > ratingGroup
        • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > ratingGroup
        • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTiered > ratingGroup
        • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > ratingGroup
      • In the response body of each of the following operations:

        • Get an order
        • Get order metrics for evergreen subscription

        Enhanced the description for each of the following fields:

        • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > ratingGroup
        • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTiered > ratingGroup
        • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > ratingGroup
        • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > ratingGroup
        • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTiered > ratingGroup
        • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > ratingGroup
      • In the response body of each of the following operations:

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

        Enhanced the description for each of the following fields:

        • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > ratingGroup
        • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTiered > ratingGroup
        • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > ratingGroup
        • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > ratingGroup
        • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTiered > ratingGroup
        • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > ratingGroup
    • In the description of the "Update invoices" operation, added a missing limitation of this operation.

Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-04-23

  •  
  • Doc Updates

     

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

     

    • Updated the description of the "Create payment method" operation to add that this operation also supports creating a standalone payment method.
    • In the request body of the "Update custom object definition" operation, updated the description of the actions > field > filterable field.
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-04-30

  •  
  • 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 300, April 2021.

  •  

    • Custom Object Definitions - Made the following updates:
      • Renamed the "Create custom object definition" operation to "Create custom object definitions".
      • Made the following updates to the "Create custom object definitions" operation:
        • Updated the request schema and sample for creating multiple custom object definitions.
        • Updated the 200 response schema and sample for returning multiple successfully created custom object definitions.

     

  • Doc Updates

     

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

  •  

    • Updated the description of the “Custom Object Jobs” section to include the link to the Postman collection of operation samples.
    • Updated the description of the Authorization header parameter for the following operations:
      • Create a notification definition
      • Query notification definitions
      • Update a notification definition
      • Get a notification definition
      • Delete a notification definition
      • Create an email template
      • Query email templates
      • Update an email template
      • Get an email template
      • Delete an email template
      • Delete notification histories for an account
      • Get a notification history deletion task
    • Updated the description of the eventCategory query parameter for the following operations:
      • Get callout notification histories
      • Get email notification histories
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-05-14

  •  
  • 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 301, May 2021.

  •  

    • Payment Gateway Reconciliation - Added an operation called “Reconcile refund”.

    • Payment Methods - In the response body of the “Get payment method” operation, added the mandateStatus and mandateReason fields.

    • Payments - In the response body of each of the following operations, added the gatewayReconciliationStatus, gatewayReconciliationReason, and payoutId fields:

      • Apply payment
      • Cancel payment
      • Create payment
      • Get all payments
      • Get payment
      • Refund payment
      • Transfer payment
      • Unapply payment
      • Update payment
    • Refunds - In the response body of each of the following operations, added the gatewayReconciliationStatus, gatewayReconciliationReason, and payoutId fields:

      • Cancel refund
      • Get all refunds
      • Get refund
      • Update refund
    • Accounts - In the request body of the "Create account" operation, resolved the issue that the soldToContact > county field was always mandatory. This field is now required only when you use Zuora Tax to calculate tax.

     

  • Doc Updates

     

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

  •  

    • Updated the description of the "Create authorization" operation.
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-05-21

  •  
  • 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 301, May 2021.

     

    • Custom Object Records - Made the following updates:
      • In the request body and sample of each of the following operations, added the allowPartialSuccess field:
        • Create custom object records
        • Update or delete custom object records as a batch
      • In the 200 response body and sample of each of the following operations, added the error object field:
        • Create custom object records
        • Update or delete custom object records as a batch

     

  • Doc Updates

     

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

  •  

    • Added a note about the "Mass Amendments Per Amend" setting for the "Amend" action.
    • In the request body of the "Preview subscription" operation, added the information about the default value for the initialTermPeriodType field.
Jing
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

  •  

    2021-05-27

  •  
  • Doc Updates

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

  •  

    • Calibrated the names of API operations for consistency and better clarity.

    • Renamed the "Get Files" section to "Files".

    • Removed the note about the "Mass Amendments Per Amend" setting from the "Amend" action.