Skip to content
Quickstart API Reference
/
/
Preview a subscription

Preview a subscription

Request

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

Security
bearerAuth
Headers
zuora-track-idstring

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 (').

asyncboolean

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.

Default:false
zuora-entity-idsstring

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-keystring

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-encodingstring

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-encodingstring

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.

Bodyapplication/jsonrequired
invoice_owner_account_idstring

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_numberstring

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_dataobject(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_idstring

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_numberstring

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_dataobject(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_renewboolean

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

subscription_numberstring

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

initial_termobject(Term)

Initial term information for the subscription.

renewal_termobject(Term)

Renewal term information for the subscription

start_onobject(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

    • descriptionstring

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

    invoice_separatelyboolean

    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.

    processing_optionsobject(ProcessingOptions)

    Processing options for the invoice or payment.

    custom_fieldsobject(CustomFields)

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

    subscription_plansArray of objects(SubscriptionPlanCreateRequest)

    The plans associated with the new subscription.

    bill_to_idstring or null

    ID of the bill-to contact.

    Example:"2c92c0f86a8dd422016a9e7a70116b0d"
    payment_termsstring or null

    The name of payment term associated with the invoice.

    billing_document_settingsobject(FlexibleBillingDocumentSettings)

    The billing document settings for the customer.

    sold_to_idstring or null

    ID of the sold-to contact.

    Example:"2c92c0f86a8dd422016a9e7a70116b0d"
    currencystring

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

    change_reasonstring

    A brief description of the reason for this change.

    number_of_periodsinteger

    Specifies how many billing periods you want to preview.

    term_endboolean

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

    metricsArray 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_datestring, (date)

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

    {
  "account_id": "8ad09b7d8292b85d0182a4d6f875225a",
  "subscription_plans": [
    { … }
  ],
  "metrics": [
    "billing_documents"
  ],
  "end_date": "2022-11-05"
}

    Responses

    Default Response

    Headers
    ratelimit-limitstring

    The request limit quota for the time window closest to exhaustion. See rate limits for more information.

    ratelimit-remainingnumber

    The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

    ratelimit-resetnumber

    The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

    zuora-request-idstring

    Zuora’s internal identifier for this request.

    zuora-track-idstring

    A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

    Bodyapplication/json
    actionsArray of objects(SubscriptionPreviewActionsResponse)
    billing_documentsArray of objects(SubscriptionPreviewBillingDocumentsResponse)
    Response
    {
  "billing_documents": [
    { … }
  ]
}