Knowledge Center

Knowledge Center > What's New > Previous Zuora Releases > 2015 New Features > November 2015 Release Notes

November 2015 Release Notes

Welcome to the Zuora November 2015 Release, R194. This release includes new Zuora features, enhancements, resolved issues, and improvements to the Knowledge Center.

Released Versions

Environment Current Product Version Release Date Current WSDL
Production R194.2 December 6, 2015 72.0
API Sandbox R194.2 December 4, 2015 72.0

See Version Information for more version information.

GA Highlights by Zuora Keys

  • PRICE: Specify Charge End Dates on Subscriptions | Create Update Product Amendments Before Future-dated Remove Product Amendments | POST Subscriptions REST Methods Support More Pricing-related Fields | GET Subscriptions REST Methods Support More Pricing-related Fields | GET Catalog REST Methods Support More Pricing-related Fields
  • BILL: Exclude Draft Invoices from Subscription and Amendment Previews
  • COLLECT: More Payment Method Card Types Supported | Ability to Pre-populate Payment Pages 2.0 with Bank Account Name  and Account Number
  • ACCOUNT: Create Revenue Schedules for Existing Transactions
  • SCALE: Configure SMTP Server for Email Notifications

Z-Suite Integrations Release

Z-Suite Integrations Release Notes November 19, 2015, v498 – Production Release

Features and Enhancements

Billing and Subscription​

New Options for Specifying Charge End Dates

Previously charges within the same subscription ended simultaneously on the subscription term end date by default. You could define when the charges started billing, but you could not define when the charges ended. Now you can define the charge end date for each individual charge with the following options:

  • Align to Subscription End Date. The charge ends on the subscription end date.
  • Fixed Period after the Charge is triggered. The charge ends after the number of periods since the charge starts billing.
  • Specific End Date. The charge ends on a specific date.

This enhancement is available from the Zuora UI, SOAP API, REST API, and data sources. Note that Zuora does not support updating the charge end date for active subscriptions.

You can define the charge end date in the Zuora UI when you perform the following operations:

  • Create or edit a product rate plan charge
  • Create a new subscription or edit a subscription in Draft status
  • Create an Add Product amendment

See End Date for more information.

The following table shows the new fields on REST API methods, SOAP API objects, and data sources.

New Field REST API Method SOAP API Object Data Source

EndDateCondition​
UpToPeriodsType

Get Catalog

ProductRatePlanCharge

Product Rate Plan Charge

EndDateCondition
UpToPeriodsType
SpecificEndDate

Get subscriptions by account
Get subscriptions by key

RatePlanCharge

Rate Plan Charge

Create Update Product Amendments Before Future-dated Remove Product Amendments

Previously if a product was removed from a subscription, you could not perform any operations on the removed product. Now you can create an Update Product amendment even if there is already a future-dated Remove Product amendment on the subscription. You no longer need to revert the future-dated amendment before creating your new amendment.

Currently this enhancement is only supported through the Zuora APIs. You can update a product with a date prior to the existing future-dated Remove Product amendment through the Zuora REST API and SOAP API.

See Update a Product on Subscription with a Future-date Remove for more information.

Create Subscription REST Methods Now Support More Pricing-related Fields

The following POST methods now let you override more fields related to pricing:

Before this release, you could only override the chargeOverride quantity field. These POST subscription methods are now more consistent with the SOAP subscribe call.

New Response Fields for POST subscriptions and subscriptions/preview
Container New Fields  

subscription

renewalSetting
​(post subscriptions only)

 

subscription > subscribeToRatePlans > chargeOverrides

number
description
price
tiers
includedUnits
overagePrice
listPriceBase
discountAmount
​discountPercentage
applyDiscountTo
discountLevel
​triggerEvent
triggerDate

billingPeriod
​specificBillingPeriod
billingPeriodAlignment​
billingTiming
billCycleType
billCycleDay
numberOfPeriods
overageUnusedUnitsCreditOption
unusedUnitsCreditRates
priceChangeOption
priceIncreasePercentage

subscription > subscribeToRatePlans > chargeOverride > tiers

tier
startingUnit
endingUnit

price
priceFormat

GET Subscriptions REST Method Response Fields Expanded

When you use the REST GET methods for subscriptions using either an account or subscription key, the response will now include more pricing fields to show how Rate Plan Charges are configured for your specific pricing models. Specifically the following fields are now part of the response:

Container New Fields  

subscription > ratePlans > ratePlanCharges

smoothingModel

 

subscription > ratePlans > ratePlanCharges > chargeSegments

priceChangeOption
currency
price

 

subscriptions > ratePlans > ratePlanCharges > chargeSegments > tiers

tier
startingUnit
endingUnit
price
priceFormat

includeUnits
overagePrice
discountPercentage
dicsountAmount

See Get subscriptions by account or Get subscriptions by key for more information.

Get Catalog REST Method Response Fields Expanded

When you use the REST GET method for catalog the response will now include more pricing fields to show how Product Rate Plan Charges are configured for your specific pricing models. Specifically the following fields are now part of the response:

Container New Fields  
catalog > products > productRatePlans > productRatePlanCharges

defaultQuantity
applyDiscountTo
​discountLevel
listPriceBase
billingPeriodAlignment
specificBillingPeriod
smoothingModel
numberOfPeriods

overageCalculationOption
overageUnusedUnitsCreditOption
usageRecordRatingOption
priceChangeOption
priceIncreasePercentage
useTenantDefaultForPriceChange
triggerEvent
​description

catalog > products > productRatePlans > productRatePlanCharges > pricing
 
currency
price
tiers
includeUnit
overagePrice
discountPercentage
discountAmount
catalog > products > productRatePlans > productRatePlanCharges > pricing > tiers

startingUnit
endingUnit

price
priceFormat

See the REST Catalog for more information. 

Exclude Draft Invoices in Subscription and Amendment Previews

Previously you could only exclude draft invoices in subscription or amendment previews through the Zuora UI or SOAP API subscribe calls. Now you can also exclude draft invoices in subscription or amendment previews through the REST API and SOAP API amend calls.

For SOAP API, you can use the IncludeExistingDraftInvoiceItems field on the PreviewOptions object with the amend call. For REST API, you can use the includeExistingDraftInvoiceItems field in the Preview subscription and Update subscription methods.

Finance

Create Revenue Schedules for Existing Transactions

You can now create revenue schedules for existing Invoice Items and Invoice Item Adjustments that don’t already have an associated revenue schedule. You can create revenue schedules for these transactions even if they have a transaction date that is before your Revenue Automation Start Date. This allows you to get a more complete picture of each month's revenue, as well as your deferred revenue balance, all in a single Revenue Detail report from Zuora.

For REST API, you can use the following new methods:

For the Mass Updater, you can use the Create Revenue Schedules mass action. Specify the transaction using the new Linked Transaction Type and Linked Transaction Key fields.

See Create Revenue Schedules for Existing Transactions for more information.

Payment

 New Payment Method Types

The following card types are now available as payment methods:

  • Credit cards: JCB, Diners, China UnionPay 
  • Debit Cards: Visa Electron, Maestro

Currently the new card types are supported only by the Test Gateway. But the new card types will appear in the list of available card types for any gateway that supports them. We are working to roll out the new card types to all gateways that support them over time.

Integration for the GlobalCollect gateway has been enhanced to support JCB.

Ability to Pre-Populate Bank Account Name and Account Number on Payment Pages

On the Bank Transfer - Direct Debit (UK) type of Payment Pages 2.0, the Account Name (bankAccountName) and Account Number (bankAccountNumber) fields could not previously be pre-populated.

Now the Account Name and Account Number fields are treated as data-sensitive fields. On the SEPA and Direct Debit (UK) types of Payment Pages 2.0, you can pre-populate Account Name and Account Number fields but the values need to be encrypted.

See Payment Pages 2.0 Form Fields for encrypting and pre-populating data-sensitive fields.

Platform

Configure SMTP Server for Email Notifications

You can now use your own SMTP server to send email notifications instead of using Zuora's default email server. The benefits for using your own SMTP server include:

  • More control over emails delivered to your customers because messages are sent through your own server
  • Ability to access sent email records through your SMTP server logs
  • No need to whitelist Zuora email servers since messages are sent through your own server

See Configure an SMTP Server for Email Notifications for more information on how your tenant administrator can configure your SMTP server from the Zuora Admin UI.

Zuora APIs

SOAP API

Date Field Changes as of WSDL 69

Please read this important note before using WSDL version 69 or later. The WSDL version as of R194 is version 72.

In WSDL 68 and earlier, 56 Zuora SOAP API date fields are treated as dateTime fields. As of WSDL 69, Zuora will treat these fields as date only fields. These fields are no longer compatible with dateTime values. Date and dateTime values in WSDL 69 are now the same as date and dateTime values in the Zuora application.

Before downloading and using WSDL 69, check to see if your SOAP integration passes or receives dateTime values to or from any of these fields.

The AQuA API is also affected by these date field changes. If you use the AQuA API, you must review the date field changes and take the appropriate action.

See Date Field Changes in the WSDL for more information.

Export ZOQL

Export ZOQL now supports WEEKOFYEAR() to interpret any timestamp date/time value or field into a week number. WEEKOFYEAR() is an ISO 8601 compliant version of WEEK(), where the first week of the year (01) is defined to start on Monday 00:00:01 and contains the first Thursday of the year.

See Export ZOQL Date and Datetime for more information.

Resolved Issues

The following issues were resolved in this release.

Finance

Discount Charges were Included in the Unprocessed Charges Report after Running the Trial Balance

Under certain conditions, discount charges were included in the Unprocessed Charges report that is generated after running a trial balance.

The issue is now resolved. Discount charges no longer appear in the Unprocessed Charges report.

REST API

Token Error on CORS-enabled REST Method Returned an Invalid JSON Response

A token error on a CORS-enabled REST API request resulted in an invalid JSON response with multiple error messages.

The issue is now resolved. When a token error occurs on a CORS-enabled REST API request, code: 90000011 returns one message:

{ "success" : false, "reasons" : [ { "message" : "Invalid token. Note: a token can only be used once.", "code" : 90000011 } ] }

See CORS REST and HMAC Signatures for more information on this error code and message.

Knowledge Center

Customer-requested Improvements to Articles

We have updated the following Knowledge Center articles based on customer-reported feedback:

  • Amendment object: Updated the RatePlanData field to correctly describe it as a container for one RatePlan object only. Previously, we described this field as a container for multiple rate plans.
  • generate() SOAP API call: Updated the code sample format and structure.
  • Set Permission for Zuora 360 Custom Objects: Updated the section "Permission Required for Zuora 360 Package Migration" and added all cases when the Customize Application system permission is required for 360 syncs.
  • Get Callout Notification Histories REST API: Updated the endpoints with the correct formatting.
  • GoCardless Gateway: Updated information for the following fields to indicate that they apply to the GoCardless Gateway:
    • Default Authorization Amount
    • Verify new credit card
    • Verify updated credit card

​Previously, this article indicated these fields did not apply to the GoCardless gateway.

Maintenance Release 194.2

This release includes internal fixes.

  • API Sandbox release, December 4, 2015
  • Production release, December 6, 2015

Maintenance Release 194.1

This release includes internal fixes.

  • API Sandbox release, December 2, 2015
Last modified
13:27, 7 Mar 2016

Tags

Classifications

(not set)