Preview a subscription by subscription key

Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.

Describes how to preview an existing subscription to view information about existing and future invoices or credit memos.

Note: The zuora-version parameter must be 207.0 or later.

Request
path Parameters
subscription-key
required
string

Subscription number or ID

header Parameters
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-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
object (PreviewStartDate)

The start date of the preview.

object (PreviewThroughDate)

The preview through date.

Array of objects (QuantityForUsageCharges)

Container for usage charges.

Responses
200
post/v1/subscriptions/{subscription-key}/preview
Request samples
application/json
{
  • "previewStartDate": {
    },
  • "previewThroughDate": {
    },
  • "quantityForUsageCharges": [
    ]
}
Response samples
application/json
{
  • "invoices": [
    ],
  • "creditMemos": [
    ],
  • "success": true
}