- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
2018-05-23
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the Zuora Object Model section, added links to the Advanced AR Settlement object model and the Orders object model.
- Made the following updates to the request body of “Preview subscription” and “Create subscription” operations:
- Corrected the
subscribeToRatePlans
>chargeOverrides
>quantity
field from required to optional, and clarified in the description that this field is not required for the flat fee pricing charge model.
- Corrected the
- Made the following updates to the “Create subscription” operation:
- Removed the minor version controlled fields
collect
,targetDate
, andrunBilling
from the request sample. - Corrected the value of the
subscribeToRatePlans
>chargeOverrides
>triggerEvent
field fromSpecificDate
toUSD
in the request sample.
- Removed the minor version controlled fields
2018-05-17
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 225, May 2018.
- Orders - Made the following updates:
- Added support for the usage charge type in the
orders
>subscriptions
>orderActions
>orderItems
field in the response body of the following operations:- Get orders by invoice owner
- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Added support for the usage charge type in the
order
>subscriptions
>orderActions
>orderItems
field in the response body of the “Get an order” operation. - Added support for the usage charge type in the
previewResult
>orderMetrics
>orderActions
>orderItems
field in the response body of the “Preview order” operation.
- Added support for the usage charge type in the
The following items are API updates specific to the change in the behavior of the memo item amount in some REST API operations. For tax-inclusive memo items, the amount indicates the memo item amount including tax. For tax-exclusive memo items, the amount indicates the memo item amount excluding tax.
-
Credit Memos - Made the following updates:
- Added the
amountWithoutTax
field to the response body of the following operations:- Get credit memo items: in the
items
field - Get credit memo item
- Get credit memo items: in the
- Changed the name of the
charges
>memoItemAmount
field tocharges
>amount
in the request body of the “Create credit memo from charge” operation. - Changed the behavior of the
items
>amount
field in the request body of the “Update credit memo” operation. - Changed the behavior of the
amount
field in the response body of the following operations:- Get credit memo items: in the
items
field - Get credit memo item
- Get credit memo items: in the
- Added the
-
Debit Memos - Made the following updates:
- Added the
amountWithoutTax
field to the response body of the following operations:- Get debit memo items: in the
items
field - Get debit memo item
- Get debit memo items: in the
- Changed the name of the
charges
>memoItemAmount
field tocharges
>amount
in the request body of the “Create debit memo from charge” operation. - Changed the behavior of the
items
>amount
field in the request body of the “Update credit memo” operation. - Changed the behavior of the
amount
field in the response body of the following operations:- Get debit memo items: in the
items
field - Get debit memo item
- Get debit memo items: in the
- Added the
-
Operations - Made the following updates in the response body of the “Create billing preview” operation:
- Added the nested
amountWithoutTax
field to thecreditMemoItems
field. - Changed the behavior of the
creditMemoItems
>amount
field.
- Added the nested
-
Subscriptions - Made the following updates in the response body of the “Preview subscription” operation:
- Added the nested
amountWithoutTax
field to thecreditMemo
>creditMemoItems
field. - Changed the behavior of the
creditMemo
>creditMemoItems
>chargeAmount
field.
- Added the nested
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Specified that the response bodies of the “Describe object” operation have type
string
. Previously, no type was specified for the response bodies of the “Describe object” operation. -
In the source YAML file, added the missing
operationId
property to the following operations:- Write off invoice
- Get invoice files
- Get invoice items
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-06-10
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 226, June 2018.
-
Accounts - Made the following updates:
- Added the
creditMemoTemplateId
anddebitMemoTemplateId
fields to the request body of the following operations:- Create account
- Update account
- Added the
creditMemoTemplateId
anddebitMemoTemplateId
fields to thebasicInfo
field in the response body of the “Get account” operation.
- Added the
-
Credit Memos - Added the
gatewayId
field to the request body of the “Refund credit memo” operation. -
Orders - Added the
ProcessingOptions
>ApplyCreditBalance
field to 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 “Create order” operation, made the following updates :
- Updated the JSON request and response samples for the following new field added to the request body:
ProcessingOptions
>ApplyCreditBalance
- In the request body, corrected the
subscriptions
>orderActions
>updateProduct
>chargeUpdates
>billing
>billingPeriodAlignment
field from required to optional. - In the description of the following
country
fields in the request body, clarified that this field is required for the use of the Zuora Tax feature:newAccont
>soldToContact
>country
newAccont
>billToContact
>country
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
>country
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
>country
- In the description of the following
billCycleDay
fields in the request body, clarified that when this field is set to0
(zero), the bill cycle day is configured as “AutoSet”:newAccount
>billCyleDay
subscriptions
>orderActions
>createSubscriptions
>newSubscriptionsOwnerAccount
>billCycleDay
- In the source YAML file, changed the
Contact
reference object name toBillToContact
in thenewAccount
>billToContact
field definition of the request body. - In the source YAML file, changed the
Contact
reference object name toSoldToContact
in thenewAccount
>soldToContact
field definition of the request body. - In the source YAML file, changed the
Contact
reference object name toBillToContact
in the definition of thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
field in the request body. - In the source YAML file, changed the
Contact
reference object name toSoldToContact
in the definition of thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
field in the request body.
- Updated the JSON request and response samples for the following new field added to the request body:
-
In the “Preview order” operation, made the following updates:
- In the request body, corrected the
previewAccountInfo
>soldToContact
field from required to optional. - In the description of the following
country
fields in the request body, clarified that this field is required for the use of the Zuora Tax feature:previewAccountInfo
>soldToContact
>country
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
>country
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
>country
- In the description of the following
billCycleDay
fields in the request body, clarified that when this field is set to0
(zero), the bill cycle day is configured as “AutoSet”:previewAccountInfo
>billCyleDay
subscriptions
>orderActions
>createSubscriptions
>newSubscriptionsOwnerAccount
>billCycleDay
- In the source YAML file, changed the
Contact
reference object name toBillToContact
in the definition of thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
field in the request body. - In the source YAML file, changed the
Contact
reference object name toSoldToContact
in the definition of thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
field in the request body.
- In the request body, corrected the
-
In the source YAML file, specified that the
zObject
reference object has additional properties. -
In the source YAML file, specified that the
zObject_update
reference object extends thezObject
reference object. -
Corrected the value of the
creditmemos
>referredInvoiceId
field in the 200 response sample of the “Get credit memos” operation. -
In the “Subscribe” action, corrected the enum values of the
PriceFormat
field fromFlat Fee
toFlatFee
and fromPer Unit
toPerUnit
. -
Added the 200 response sample to the “CRUD: Retrieve Subscription” operation.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
2018-06-28
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 227, June 2018.
- Payment Methods - Added a new operation called “Scrub payment method”.
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the Zuora Object Model section, corrected the API name of the Billing Run object and clarified that the Billing Run object has different API names in different contexts. Previously the API name was listed as
BillRun
, which is incorrect for the “Describe object” operation. -
Made the following updates to the request body of the “Subscribe” action:
- Corrected the description of the
subscribes
>PreviewOptions
field and the descriptions of its nested fields. - Removed the
subscribes
>PreviewOptions
>IncludeExistingDraftInvoiceItems
field.
- Corrected the description of the
-
In the “Get breakdown of invoice by order” operation, added the description for the Phantom Invoice Item feature.
-
In the “Create order” operation, added the missing
zuora-version
parameter to header parameters. -
In the request body of the “Preview order” operation, corrected the
previewOptions
field from optional to required.
2018-06-21
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 227, June 2018.
-
Payment Methods - Added a new operation called “Create payment method”. The previous operation with this name is now called “Create credit card payment method”.
-
Notifications - Made the following updates:
- Removed the
filterRule
>name
field from the request schema and sample of the following operations:- Create a notification definition
- Update a notification definition
- Removed the
filterRule
>name
field from the response schema and 200 response sample of the following operations:- Create a notification definition
- Query notification definitions
- Update a notification definition
- Get a notification definition
- Removed the
-
Orders - In the “Create order” operation, made the following updates:
- In the request body, added the
invoiceDeliveryPrefsPrint
andinvoiceDeliveryPrefsEmail
fields to the following fields:newAccount
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
- In the request body, updated the
processingOptions
>ElectronicPaymentOptions
>PaymentMethodId
field to reflect the enhancement that if an orphan payment method is specified in this field, this operation will associate the payment method with the account that this order will be created under, regardless of whether the payment has been processed.
- In the request body, added the
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Added a new subsection called Timeout Limit in the Requests and Responses section.
-
In the “Create credit memo from charge” and “Create debit memo from charge” operations, made the following updates:
- Added the missing
zuora-version
parameter to header parameters. - Added the missing
charges
>memoItemAmount
field to the request body. This field is in Zuora API version control and only available in Zuora REST API version 223.0 and earlier. Added this field to the Minor Version History section accordingly. - In the description of the
charges
>amount
field in the request body, noted that this field is in Zuora API version control and only available in Zuora REST API version 224.0 and later. Added this field to the Minor Version History section accordingly.
- Added the missing
-
Changed the name of the “Create payment method” operation to “Create credit card payment method”. A new operation called “Create payment method” is now available.
-
Changed the name of the “Update payment method” operation to “Update credit card payment method”.
-
Changed the name of the “Get payment methods” operation to “Get credit card payment methods for account”.
-
Corrected the 200 response schema in the “Delete” action. Previously the response schema was an object called
result
. -
In the “Create order” operation, made the following updates:
- Added the missing
subscriptionsNumbers
field to the request body. This field is in Zuora API version control and only available in Zuora REST API version 222.4 and earlier. Added this field to the Minor Version History section accordingly. - In the description of the
subscriptions
field in the request body, noted that this field is in Zuora API version control and only available in Zuora REST API version 223.0 and later. Added this field to the Minor Version History section accordingly.
- Added the missing
-
In the “Preview order” operation, made the following updates:
- Corrected the definition of the
previewResult
>orderMetrics
>orderActions
>orderMetrics
field in the response body. Previously it was defined as an array of array. Additionally, made the following updates in the source YAML file for this correction:- Changed the
OrderMetrics
reference object name toorderMetric
. - Redefined the
orderMetric
reference object as an object. Previously, it was defined as an array.
- Changed the
- Corrected the definition of the
-
In the “Get an order” operation, changed the definition of the
Order
>subscriptions
>orderActions
>orderMetrics
field from a reference to theOrderMetrics
object to an array that contains items of theorderMetric
reference object. -
In the following operations, changed the definition of the
Orders
>subscriptions
>orderActions
>orderMetrics
field from a reference to theOrderMetrics
object to an array that contains items of theorderMetric
reference object:- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-07-11
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 228, July 2018.
-
Catalog - In the “Get catalog” operation, changed the behavior of the
productRatePlans
field in the response body. When you call this operation, a URL is returned as the value of theproductRatePlans
field, instead of product rate plan details. The URLs correspond to the new “Get product rate plans” call. See the descriptions of theproductRatePlans
fields to find out how to enable the latest behavior in your tenant. -
Product Rate Plans - Added a new operation called “Get product rate plans”.
Doc Updates
- In the “Amend” action, made the following updates:
- Updated the description of the operation to clarify that the operation cannot be used to amend multiple subscriptions.
- Added a description for the
requests
field in the request body. - Correctly documented which Amendment object fields are required. Previously, the operation description and the request body listed different Amendment object fields as required.
2018-07-05
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 228, July 2018.
-
Payment Methods - Made the following updates to the "Create payment method" operation:
-
In the operation description, updated the different fields specific to each payment method type.
-
In the
type
field, added the support for thePayPalNativeEC
andPayPalAdaptive
values. -
Changed the
BAID
andemail
fields from required to optional because these fields are conditionally required, and updated the corresponding description. -
Added the
preapprovalKey
field for the PayPal Adaptive payment method.
-
-
Transactions - In the “Get invoices” operation, changed the behavior of the
invoiceItems
andinvoiceFiles
fields in the response body. When you call this operation, URLs are returned as the values of theinvoiceItems
andinvoiceFiles
fields, instead of invoice item details and invoice file details. The URLs correspond to the “Get invoice items” and “Get invoice files” operations. See the descriptions of theinvoiceItems
andinvoiceFiles
fields to find out how to enable the latest behavior in your tenant.
-
Orders - In the request body of the “Create order” operation, added the
customFields
container to the following fields:newAccount
>billToContact
newAccount
>soldToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the “Create order” operation, added a note about payment processing failures.
- In all relevant operations, changed the name of the Advanced AR Settlement feature to Invoice Settlement, and updated all related reference links.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-07-18
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 229, July 2018.
-
Accounts - Added the following new operations:
- Create job to hard delete billing document files
- Get job of hard deleting billing document files
-
Catalog - In the “Multi-entity: Share a Product with an Entity” operation, made the following updates:
- Changed the HTTP method from “PUT” to “POST” in order to eliminate misunderstanding.
- In the source file, changed the value of the
operationId
field fromPUT_Catalog
toPOST_Catalog
, and renamed thePUTCatalogType
reference object toPOSTCatalogType
.
-
Credit Memos - The “Create credit memo PDF” operation now depends on the Billing user permission “Regenerate PDF”. The operation description explains more details.
-
Debit Memos - The “Create debit memo PDF” operation now depends on the Billing user permission “Regenerate PDF”. The operation description explains more details.
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the “Amend” action, made the following updates:
- Updated the description of the action to clarify the order in which Zuora modifies the subscription.
- Improved the JSON request sample.
-
Removed the “CRUD: Create amendment” operation. This operation has significant limitations and Zuora recommends that you use the “Update subscription” operation or the “Amend” action instead.
-
In the response body of the following operations, corrected the format of the
order
>createdDate
andorder
>updatedDate
fields todatetime
:- Get an order
- Get order metrics for evergreen subscription
-
In the response body of the following operations, corrected the format of the
orders
>createdDate
andorders
>updatedDate
fields todatetime
:- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-07-30
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, added the missing
exemptEntityUseCode
nested field to thetaxInfo
field:- Create account
- Update account
- In the response body of the following operations, added the missing
exemptEntityUseCode
nested field to thetaxInfo
field:- Get account
- Get account summary
- In the description of the
productRatePlans
field in the response body of the “Get product catalog” operation, clarified that if you do not have product rate plan references enabled in the REST API, the value of this field is an array of product rate plan details. - In the description of the “Create credit card payment method” operation, added a note to indicate that you are subject to PCI-compliance audit requirements if you are using this operation instead of the Hosted Payment Pages iFrame.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-08-10
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 230, August 2018.
-
Notifications - Removed the “Get callout options” and “Update callout options” operations. Previously, these operations caused inconsistency between API and UI. Hence, we have disabled these operations to avoid confusion.
-
Payment Runs - Made the following updates:
- In the following operations, added the
collectPayment
field to the request body:- Create payment run
- Update payment run
- In the following operations, added the
collectPayment
field to the response body:- Create payment run
- Update payment run
- Ger payment run
- In the “Get payment runs” operation, added the
collectPayment
nested field to thepaymentRuns
field in the response body.
- In the following operations, added the
-
Catalog - In the “Get product catalog” operation, made the following updates:
- Added the
zuora-version
parameter to header parameters. - In the response body, updated the description of the
productRatePlans
field by adding version control information.
- Added the
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
Corrected the URL paths of the following operations:
- CRUD: Get amendment
- CRUD: Update amendment
- CRUD: Delete amendment
The URL paths of the operations were documented as
/v1/object/amendmexnt/{id}
in versions 2018-07-18 and 2018-07-30 of the API Reference. -
In the “Get payment runs” operation, added
/v1
to examples in thefieldsFilterable
andsort
query parameters. -
In the “Create order” operation, corrected the names of the following request body fields:
processingOptions
>electronicPaymentOptions
processingOptions
>electronicPaymentOptions
>paymentMethodId
Previously, the field names were documented as
ElectronicPaymentOptions
andPaymentMethodId
.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-08-23
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 231, August 2018.
- Catalog - Added a new operation called “Get product”.
- Credit Memos - Added a new operation called “Unpost credit memo”.
- Debit Memos - Added a new operation called “Unpost debit memo”.
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 order action trigger dates” operation, made the following updates:
- Corrected the
subscriptions
>subscriptionNumber
field from optional to required. - Corrected the
subscriptions
>orderActions
>sequence
field from optional to required and clarified the description of the field.
- Corrected the
-
In the description of the
processPayment
request field of the “Create Apple Pay payment method” operation, clarified that if you set this field totrue
, you must specify thepaymentGateway
request field with the gateway instance name. -
In the following operations, added
/v1
to examples in thefieldsFilterable
andsort
query parameters.- Get credit memos
- Get credit memo items
- Get debit memos
- Get debit memo items
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-08-29
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 all orders” operation, made the following updates:
- Added the missing
orders
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>newRatePlanId
field. - Added the missing
orders
>subscriptions
>orderActions
>addProduct
>newRatePlanId
field. - Added the missing
orders
>subscriptions
>orderActions
>updateProduct
>newRatePlanId
field. - Removed the nonexistent
orders
>subscriptions
>orderActions
>addProduct
>originRatePlanId
field. - Removed the nonexistent
orders
>subscriptions
>orderActions
>updateProduct
>originRatePlanId
field. - Removed the nonexistent
orders
>subscriptions
>orderActions
>removeProduct
>originRatePlanId
field.
- Added the missing
-
In the response bodies of the following operations:
- Get an order
- Get order metrics for evergreen subscription
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
Made the following updates:
- Added the missing
order
>subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>newRatePlanId
field. - Added the missing
order
>subscriptions
>orderActions
>addProduct
>newRatePlanId
field. - Added the missing
order
>subscriptions
>orderActions
>updateProduct
>newRatePlanId
field. - Removed the nonexistent
order
>subscriptions
>orderActions
>addProduct
>originRatePlanId
field. - Removed the nonexistent
order
>subscriptions
>orderActions
>updateProduct
>originRatePlanId
field. - Removed the nonexistent
order
>subscriptions
>orderActions
>removeProduct
>originRatePlanId
field.
-
In the source YAML file, replaced the
OrderActionRequest
reference object by the following new reference objects:- A reference object called
CreateOrderOrderAction
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderOrderAction
that is used in the request body of the “Preview order” operation.
- A reference object called
-
In the source YAML file, duplicated the
CreateSubscription
reference object as the following new reference objects:- A reference object called
CreateOrderCreateSubscription
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderCreateSubscription
that is used in the request body of the “Preview order” operation. - A reference object called
CreateSubscriptionForEvergreen
that is used in the response body of the “Get order metrics for evergreen subscription” operation.
- A reference object called
-
In the source YAML file, duplicated the
RatePlanOverride
reference object as the following new reference objects:- A reference object called
CreateOrderRatePlanOverride
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderRatePlanOverride
that is used in the request body of the “Preview order” operation. - A reference object called
RatePlanOverrideForEvergreen
that is used in the response body of the “Get order metrics for evergreen subscription” operation.
- A reference object called
-
In the source YAML file, duplicated the
RatePlanUpdate
reference object as the following new reference objects:- A reference object called
CreateOrderRatePlanUpdate
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderRatePlanUpdate
that is used in the request body of the “Preview order” operation. - A reference object called
RatePlanUpdateForEvergreen
that is used in the response body of the “Get order metrics for evergreen subscription” operation.
- A reference object called
-
In the source YAML file, duplicated the
ChargeOverride
reference object as the following new reference objects:- A reference object called
CreateOrderChargeOverride
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderChargeOverride
that is used in the request body of the “Preview order” operation. - A reference object called
ChargeOverrideForEvergreen
that is used in the response body of the “Get order metrics for evergreen subscription” operation.
- A reference object called
-
In the source YAML file, duplicated the
ChargeUpdate
reference object as the following new reference objects:- A reference object called
CreateOrderChargeUpdate
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderChargeUpdate
that is used in the request body of the “Preview order” operation. - A reference object called
ChargeUpdateForEvergreen
that is used in the response body of the “Get order metrics for evergreen subscription” operation.
- A reference object called
-
In the source YAML file, duplicated the
PricingUpdate
reference object as the following new reference objects:- A reference object called
CreateOrderPricingUpdate
that is used in the request body of the “Create order” operation. - A reference object called
PreviewOrderPricingUpdate
that is used in the request body of the “Preview order” operation. - A reference object called
PricingUpdateForEvergreen
that is used in the response body of the “Get order metrics for evergreen subscription” operation.
- A reference object called
-
In the source YAML file, removed the following reference objects:
OrderActionAddProduct
OrderActionForEvergreenAddProduct
OrderActionUpdateProduct
OrderActionForEvergreenUpdateProduct
OrderActionRemoveProduct
OrderActionForEvergreenRemoveProduct
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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!
2018-09-07
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- Removed the redundant
eventTypeName
field from thefilterRule
object in the request body of the “Create a notification definition” operation. The code sample was updated accordingly.