2017-09-06

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the September 2017 release, R216.

 

• Orders - Added a new resource "Orders".
• Credit Memos - Added a new operation "Get breakdown of credit memo by order".
• Invoices - Added a new operation "Get breakdown of invoice by order".
• Payment Methods - Made the following updates:
  • Added a new operation “Verify payment method”.
  • Added the numConsecutiveFailures field to the request body of the “Create payment method” and “Update payment method” operations.
  • Added the NumConsecutiveFailures field to the request body of the “CRUD: Create payment method” operation.

• Subscriptions - Added the orderNumber field to the response of the “Get subscription by key”, “Get subscriptions by account”, and “Get subscriptions by key and version” operations.

 

Doc Updates

 

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

 

• In the Action and CRUD operations, corrected the required fields and conditionally required fields, added the missing nested fields, and removed one unsupported CRUD operation.
• Added the missing cancelledOn and cancelledById fields to the response of the “Create credit memo from charge”, “Create credit memo from invoice”, “Get credit memo”, “Get credit memos”, “Update credit memo”, “Apply credit memo”, “Unapply credit memo”, “Cancel credit memo”, “Post credit memo”, “Query credit memos by account”, “Create debit memo from charge”, “Create debit memo from invoice”, “Get debit memo”, “Get debit memos”, “Update debit memo”, “Cancel debit memo”, and “Post debit memo” operations. 
• Added the missing autoRenew field to the request body of the “Create subscription” operation.
• In the "Create billing preview" operation, corrected the type and description of the processingType field.