- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
Re: API Changelog
2018-04-16
API Updates
This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the April 2018 release, R223.
- Orders - Made the following updates:
- Added a new operation “Update order action trigger dates”.
- In the "Create order" operation, added a new field
status
in the response body. - In the response body of the "Create order" operation, replaced the
scriptionNumbers
field by thesubscriptions
field and its nested fields. - In the response body of the "Get an order" operation, added a new value
Pending
to theOrder
>status
field. - In the response bodies of the following operations, added a new value
Pending
to theOrders
>status
field:
- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
- In the response body of the "Create order" operation, added a new field
ElectronicPaymentOptions
and its nested fields to theprocessingOptions
field. - In the response body of the "Create order" operation, added a new field
parentId
to thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
field.
- Payment Methods - Added new operations “Create Authorization” and “Cancel Authorization”.
- OAuth - Made the following updates to the “Generate an OAuth token” operation:
- Implemented rate limiting by IP address and added the corresponding 429 response code.
- Added new response headers
X-RateLimit-Limit-minute
andX-RateLimit-Remaining-minute
.
- Event Triggers - In the “Create an event trigger” operation, added the Order and OrderAction objects to the list of supported objects.
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- Corrected the endpoints of several Notification operations. Previously, the endpoints
/notifications/email-templates
and/notifications/callout-options
were incorrectly documented as/notification/email-templates
and/notification/callout-options
. - In the “Create an event trigger” operation, modified the note that the number of event triggers you can create depends on the edition of Zuora platform you are using.
- Added quantity limitations to the descriptions of the following operations:
- Apply credit memo
- Unapply credit memo
- Create payment
- Apply payment
- Made the following updates to Orders operations:
- Renamed the "Create and activate order" operation to "Create order".
- Updated the description of the
subscriptions
>orderActions
>triggerDates
field in the request body of the "Create order" operation. - Updated the description of the
subscriptions
>orderActions
>createSubscription
>subscribeToRatePlans
>chargeOverrides
>startDate
>specificTriggerDate
field in the request body of the "Create order" operation. - Updated the description of the
orderNumber
field in the response body of the "Create order" operation. - Updated the request sample for the "Create order" operation. The request sample now includes the pending order and subscription feature.
- Updated the response sample of the "Create order" operation. The response sample now includes the pending order and subscription feature.
- In several operations, improved the documentation of the
createSubscription
order action so that the purpose of each field is more clearly explained.
- Removed the following nonexistent fields from the request bodies of the “Preview subscription”, “Renew subscription”, and “Cancel subscription” operations:
OpportunityCloseDate_QT
OpportunityName_QT
QuoteBusinessType_QT
QuoteNumber_QT
QuoteType_QT
- Added fields provided by the Zuora Connector for NetSuite. The names of these fields end with
__NS
. The following Zuora business objects have fields provided by the Zuora Connector for NetSuite:- Account
- Credit Balance Adjustment
- Credit Memo
- Debit Memo
- Invoice
- Invoice Item
- Payment
- Product
- Product Rate Plan
- Product Rate Plan Charge
- Refund
- Subscription
- Made the following changes to improve the structure of the source YAML file:
- Removed the
BigDecimal
format from numerical fields. - Changed the
TriggerDates
reference object from an array to an object and renamed itTriggerDate
. - Replaced the
ObjectCustomFields
reference object by new reference objects corresponding to different Zuora business objects. For example, the newRatePlanChargeObjectCustomFields
reference object represents custom fields of a Rate Plan Charge object. - Merged the
newSubscriptionOwnerAccount
reference object into theCreateSubscription
reference object. - Merged the
Terms
reference object into theCreateSubscription
reference object. - Merged the
InitialTerm
reference object into theCreateSubscription
reference object. - Merged the
PricingOverride
reference object into theChargeOverride
reference object. - Merged the
BillingOverride
reference object into theChargeOverride
reference object. - In the
OrderActionForEvergreen
reference object, replaced theaddProduct
,updateProduct
, andremoveProduct
nested fields by references to new reference objects calledOrderActionForEvergreenAddProduct
,OrderActionForEvergreenUpdateProduct
, andOrderActionForEvergreenRemoveProduct
. - In the
OrderAction
reference object, replaced theaddProduct
,updateProduct
, andremoveProduct
nested fields by references to new reference objects calledOrderActionAddProduct
,OrderActionUpdateProduct
, andOrderActionRemoveProduct
.
- Removed the
-
In the source YAML file, replaced placeholder fields called
customField__c
by reference objects that correctly represent custom fields. Each new reference object represents custom fields of a Zuora business object. For example, the newRatePlanChargeObjectCustomFields
reference object represents custom fields of a Rate Plan Charge object.These changes affect the following reference objects:
AmendmentRatePlanChargeDataRatePlanCharge
(new reference object; previously part ofAmendmentRatePlanChargeData
)CreatePaymentType
CreditMemoFromChargeDetailType
CreditMemoFromChargeType
CreditMemoFromInvoiceType
CreditMemoItemFromInvoiceItemType
DebitMemoFromChargeDetailType
DebitMemoFromChargeType
DebitMemoFromInvoiceType
DebitMemoItemFromInvoiceItemType
EventRevenueItemType
GETARPaymentType
GETARPaymentTypewithSuccess
GETAccountSummarySubscriptionType
GETAccountSummaryTypeBasicInfo
(new reference object; previously part ofGETAccountSummaryType
)GETAccountSummaryTypeBillToContact
(new reference object; previously part ofGETAccountSummaryType
)GETAccountSummaryTypeSoldToContact
(new reference object; previously part ofGETAccountSummaryType
)GETAccountTypeBasicInfo
(new reference object; previously part ofGETAccountType
)GETAccountTypeBillToContact
(new reference object; previously part ofGETAccountType
)GETAccountTypeSoldToContact
(new reference object; previously part ofGETAccountType
)GETAccountingCodeItemType
GETAccountingCodeItemWithoutSuccessType
GETAccountingPeriodType
GETAccountingPeriodWithoutSuccessType
GETCreditMemoItemType
GETCreditMemoItemTypewithSuccess
GETCreditMemoType
GETCreditMemoTypewithSuccess
GETDebitMemoItemType
GETDebitMemoItemTypewithSuccess
GETDebitMemoType
GETDebitMemoTypewithSuccess
GETInvoiceType
GETInvoicesInvoiceItemType
GETJournalEntryDetailType
GETJournalEntryDetailTypeWithoutSuccess
GETJournalEntryItemType
GETPaymentType
GETProductRatePlanChargeType
GETProductRatePlanType
GETProductType
GETRSDetailForProductChargeType
GETRSDetailType
GETRSDetailWithoutSuccessType
GETRefundCreditMemoType
GETRefundPaymentType
GETRefundType
GETRefundTypewithSuccess
GETRevenueEventDetailType
GETRevenueEventDetailWithoutSuccessType
GETRevenueItemType
GETRsRevenueItemType
GETSubscriptionRatePlanChargesType
GETSubscriptionRatePlanType
GETSubscriptionType
GETSubscriptionTypeWithSuccess
GETTaxationItemType
GETTaxationItemTypewithSuccess
GETUsageType
GetProductFeatureType
InvoiceDataInvoice
(new reference object; previously part ofInvoiceData
)InvoiceItem
POSTAccountType
POSTAccountTypeBillToContact
(new reference object; previously part ofPOSTAccountType
)POSTAccountTypeSoldToContact
(new reference object; previously part ofPOSTAccountType
)POSTAccountTypeSubscription
(new reference object; previously part ofPOSTAccountType
)POSTAccountingCodeType
POSTAccountingPeriodType
POSTJournalEntryItemType
POSTJournalEntryType
POSTRevenueScheduleByChargeType
POSTRevenueScheduleByChargeTypeRevenueEvent
(new reference object; previously part ofPOSTRevenueScheduleByChargeType
)POSTRevenueScheduleByDateRangeType
POSTRevenueScheduleByDateRangeTypeRevenueEvent
(new reference object; previously part ofPOSTRevenueScheduleByDateRangeType
)POSTRevenueScheduleByTransactionRatablyType
POSTRevenueScheduleByTransactionRatablyTypeRevenueEvent
(new reference object; previously part ofPOSTRevenueScheduleByTransactionRatablyType
)POSTRevenueScheduleByTransactionType
POSTRevenueScheduleByTransactionTypeRevenueEvent
(new reference object; previously part ofPOSTRevenueScheduleByTransactionType
)POSTScCreateType
POSTSrpCreateType
POSTSubscriptionPreviewTypePreviewAccountInfo
(new reference object; previously part ofPOSTSubscriptionPreviewType
)POSTSubscriptionType
POSTTaxationItemForCMType
POSTTaxationItemForDMType
PUTAccountType
PUTAccountTypeBillToContact
(new reference object; previously part ofPUTAccountType
)PUTAccountTypeSoldToContact
(new reference object; previously part ofPUTAccountType
)PUTAccountingCodeType
PUTAccountingPeriodType
PUTAllocateManuallyType
PUTCreditMemoItemType
PUTCreditMemoType
PUTDebitMemoItemType
PUTDebitMemoType
PUTJournalEntryItemType
PUTRSBasicInfoType
PUTRSTermType
PUTRefundType
PUTScAddType
PUTScUpdateType
PUTSpecificDateAllocationType
PUTSrpAddType
PUTSrpUpdateType
PUTSubscriptionType
PUTTaxationItemType
PUT_BasicSummaryJournalEntryType
PostNonRefRefundType
PostRefundType
ProxyCreateAccount
ProxyCreateAmendment
ProxyCreateContact
ProxyCreateInvoiceAdjustment
ProxyCreatePayment
ProxyCreateProduct
ProxyCreateProductRatePlan
ProxyCreateRefund
ProxyCreateTaxationItem
ProxyCreateUsage
ProxyGetAccount
ProxyGetAmendment
ProxyGetContact
ProxyGetCreditBalanceAdjustment
ProxyGetFeature
ProxyGetInvoice
ProxyGetInvoiceAdjustment
ProxyGetInvoiceItem
ProxyGetInvoiceItemAdjustment
ProxyGetPayment
ProxyGetProduct
ProxyGetProductFeature
ProxyGetProductRatePlan
ProxyGetProductRatePlanCharge
ProxyGetRatePlan
ProxyGetRatePlanCharge
ProxyGetRefund
ProxyGetSubscription
ProxyGetSubscriptionProductFeature
ProxyGetTaxationItem
ProxyGetUsage
ProxyModifyAccount
ProxyModifyAmendment
ProxyModifyContact
ProxyModifyInvoice
ProxyModifyInvoiceAdjustment
ProxyModifyPayment
ProxyModifyProduct
ProxyModifyProductRatePlan
ProxyModifyRefund
ProxyModifySubscription
ProxyModifyTaxationItem
ProxyModifyUsage
PutInvoiceResponseType
RatePlanChargeDataRatePlanCharge
(new reference object; previously part ofRatePlanChargeData
)RatePlanDataRatePlan
(new reference object; previously part ofRatePlanData
)RevenueScheduleItemType
SubscribeRequestAccount
(new reference object; previously part ofSubscribeRequest
)SubscribeRequestBillToContact
(new reference object; previously part ofSubscribeRequest
)SubscribeRequestSoldToContact
(new reference object; previously part ofSubscribeRequest
)SubscribeRequestSubscriptionDataSubscription
(new reference object; previously part ofSubscribeRequest
)SubscriptionProductFeature
UpdatePaymentType
See Advance notice of change to custom field support in the Zuora Swagger spec for information about the impact of these changes.