Preview a subscription

The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing.

Notes

  • The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers.

  • If you have the Invoice Settlement feature enabled, we recommend that you set the zuora-version parameter to 207.0 or later available versions. Otherwise, an error is returned.

  • Default values for customerAcceptanceDate and serviceActivationDate are set as follows.

serviceActivationDate (SA) specified serviceActivationDate (SA) NOT specified
customerAcceptanceDate (CA) specified SA uses value in the request call; CA uses value in the request call CA uses value in the request call;SA uses CE as default
customerAcceptanceDate (CA) NOT specified SA uses value in the request call; CA uses SA as default SA and CA use CE as default
Request
header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

zuora-version
string

The minor version of the Zuora REST API.

You need to set this parameter if you use the following fields:

  • targetDate
  • includeExistingDraftDocItems
  • previewType
  • taxationItems

If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned.

.

Request Body schema: application/json
required
termType
required
string

Possible values are: TERMED, EVERGREEN.

contractEffectiveDate
required
string <date>

Effective contract date for this subscription, as yyyy-mm-dd.

required
Array of objects (subscribeToRatePlans)

Container for one or more rate plans for this subscription.

accountKey
string

Customer account number or ID.

You must specify the account information either in this field or in the previewAccountInfo field with the following conditions:

  • If you already have a customer account, specify the account number or ID in this field.
  • If you do not have a customer account, provide account information in the previewAccountInfo field.
customerAcceptanceDate
string <date>

The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.

Default value is dependent on the value of other fields. See Notes section for more details.

documentDate
string <date>

The date of the billing document, in yyyy-mm-dd format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

  • If this field is specified, the specified date is used as the billing document date.
  • If this field is not specified, the date specified in the targetDate is used as the billing document date.
includeExistingDraftDocItems
boolean

Specifies whether to include draft invoice items in subscription previews. Values are:

  • true (default). Includes draft invoice items in the preview result.
  • false. Excludes draft invoice items in the preview result.

Note: This field is in Zuora REST API version control. Supported minor versions are 207.0 or later available versions.

includeExistingDraftInvoiceItems
boolean

Specifies whether to include draft invoice items in previews. Values are:

  • true (default). Includes draft invoice items in the preview result.
  • false. Excludes draft invoice items in the preview result.

Note: This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0.

initialTerm
integer <int64>

Duration of the first term of the subscription, in whole months. If termType is TERMED, then this field is required, and the value must be greater than 0. If termType is EVERGREEN, this field is ignored.

initialTermPeriodType
string

The period type of the initial term.

Supported values are:

  • Month
  • Year
  • Day
  • Week

The default period type is Month.

invoiceOwnerAccountKey
string

Invoice owner account number or ID.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

invoiceTargetDate
string <date>

Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.

Note: This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. .

notes
string

String of up to 500 characters.

object (previewAccountInfo)

A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for subscription preview.

You must specify the account information either in this field or in the accountKey field with the following conditions:

  • If you already have a customer account, specify the account number or ID in the accountKey field.
  • If you do not have a customer account, provide account information in this field.
previewType
string

The type of preview you will receive.

This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.

  • If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:

    • 186.0
    • 187.0
    • 188.0
    • 189.0
    • 196.0
    • 206.0

    The following values are supported in the previewType field:

    • InvoiceItem
    • ChargeMetrics
    • InvoiceItemChargeMetrics

    The default value is InvoiceItem.

  • If you specify the REST API minor version to 207.0 or later available versions in the request header, the following values are supported in the previewType field:

    • LegalDoc
    • ChargeMetrics
    • LegalDocChargeMetrics

    The default value is LegalDoc.

.

serviceActivationDate
string <date>

The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.

Default value is dependent on the value of other fields. See Notes section for more details.

targetDate
string <date>

Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.

Note: This field is in Zuora REST API version control. Supported minor versions are 207.0 or later available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

termStartDate
string <date>

The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.

property name*
additional property
any

Custom fields of the Subscription object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
post/v1/subscriptions/preview
Request samples
application/json
{
  • "contractEffectiveDate": "2013-1-15",
  • "initialTerm": 12,
  • "initialTermPeriodType": "Week",
  • "invoiceTargetDate": "2013-12-31",
  • "previewAccountInfo": {
    },
  • "subscribeToRatePlans": [
    ],
  • "termType": "TERMED"
}
Response samples
application/json
{
  • "amount": 100,
  • "amountWithoutTax": 90,
  • "contractedMrr": 100,
  • "invoice": {
    },
  • "invoiceTargetDate": "2021-12-31",
  • "success": true,
  • "taxAmount": 10
}