Preview a subscription

You can preview the billing document metrics or the order delta metrics across a specified time frame.

SecuritybearerAuth
Request
header Parameters
zuora-track-id
string

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your 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 ("), or quote (').

async
boolean
Default: false

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

zuora-entity-ids
string

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

idempotency-key
string

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. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encoding
string

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encoding
string

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

Request Body schema: application/json
required
invoice_owner_account_id
string

Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify invoice_owner_account_data.

invoice_owner_account_number
string

Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify invoice_owner_account_data.

object (AccountCreateRequest)

The information of the new account that owns the invoice associated with this subscription. If you specify this field, do not specify invoice_owner_account_id.

account_id
string

Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify account_data.

account_number
string

Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify account_data.

object (SubscriptionPreviewAccountRequest)

Account data that is used for the subscription preview. If you specify this field, do not specify account_id. Note that this operation is only for preview and no subscription is created.

auto_renew
boolean

If true, the subscription automatically renews at the end of the current term.

subscription_number
string

Human-readable identifier of the subscription; maybe user-supplied.

object (Term)

Initial term information for the subscription.

object (Term)

Renewal term information for the subscription

object (StartOn)

Container for the contract effective, service activation, and customer acceptance dates of the order action or subscription.

  • If Zuora is configured to require service activation and the service_activation field is not set for a subscription_plans order action or the "Create a subscription" operation, a pending order and/or a pending_activation subscription are created.
  • If Zuora is configured to require customer acceptance and the customer_acceptance field is not set for a subscription_plans order action or the "Create a subscription" operation, a pending order and/or a pending_acceptance subscription are created. At the same time, if the service activation date field is also required and not set, a pending order and/or a pending_activation subscription are created instead.
  • If Zuora is configured to require service activation and the service_activation field is not set for any of the following order actions or the "Update a subscription" operation, a pending order is created. The subscription status is not impacted. Note: This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.
    • add_subscription_plans
    • update_subscription_plans
    • remove_subscription_plans
    • renew
    • terms
  • If Zuora is configured to require customer acceptance and the customer_acceptance field is not set for any of the following order actions or the "Update a subscription" operation, a pending order is created. The subscription status is not impacted. Note: This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.
    • add_subscription_plans
    • update_subscription_plans
    • remove_subscription_plans
    • renew
    • terms

description
string

Description of the subscription. Often useful for displaying to users.

invoice_separately
boolean

Separates a single subscription from other subscriptions and creates an invoice for this subscription. If the value is true, the subscription is billed separately from other subscriptions. If the value is false, the subscription is included with other subscriptions in the account invoice.

object (ProcessingOptions)

Processing options for the invoice or payment.

object (CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

Array of objects (SubscriptionPlanCreateRequest)

The plans associated with the new subscription.

bill_to_id
string or null

ID of the bill-to contact.

payment_terms
string or null

The name of payment term associated with the invoice.

object (FlexibleBillingDocumentSettings)

The billing document settings for the customer.

sold_to_id
string or null

ID of the sold-to contact.

currency
string

3-letter ISO 4217 currency code. This field is available only if you have the Multiple Currencies feature enabled.

change_reason
string

A brief description of the reason for this change.

number_of_periods
integer

Specifies how many billing periods you want to preview.

term_end
boolean

Indicates whether to preview the subscription till the end of the current term.

metrics
Array of strings

Specifies the metrics you want to preview. You can preivew metrics of billing documents, the order delta metrics, or both.

Items Enum: "billing_documents" "delta_metrics"
end_date
string <date>

End date of the period for which you want to preview the subscription

Responses
200

Default Response

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/subscriptions/preview
Request samples
application/json
{
  • "account_id": "8ad09b7d8292b85d0182a4d6f875225a",
  • "subscription_plans": [
    ],
  • "metrics": [
    ],
  • "end_date": "2022-11-05"
}
Response samples
application/json
{
  • "billing_documents": [
    ]
}