Preview an existing subscription

Request

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

Security

bearerAuth

Path

subscription_idstringrequired

Identifier for the subscription, either subscription_number or subscription_id

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

custom_fieldsobject(CustomFields)

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

descriptionstring

Description of the subscription.

account_idstring

Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account.

account_numberstring

Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account.

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.

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

add_subscription_plansArray of objects(SubscriptionAddPlanPatchRequest)

Specify this field if you want to add one or multiple subscription plans to this subscription.

replace_subscription_plansArray of objects(SubscriptionReplacePlanPatchRequest)

Specify this field if you want to replace one or multiple subscription plans to this subscription.
Note: This field is currently not supported if you have Billing - Revenue Integration enabled. When Billing - Revenue Integration is enabled, the replace subscription plan type of order action will no longer be applicable in Zuora Billing.

update_subscription_plansArray of objects(SubscriptionUpdatePlanPatchRequest)

remove_subscription_plansArray of objects(SubscriptionRemovePlanPatchRequest)

Specify this field if you want to remove one or multiple subscription plans from this subscription.

{
  "account_id": "8ad08d29857fc0ec0185829faf0507d7",
  "description": "lorem ipsum dolor sit amet",
  "number_of_periods": 2,
  "term_end": true,
  "end_date": "2023-08-20",
  "custom_fields": {
    "TestSubscriptionRequired__c": "abc"
  },
  "add_subscription_plans": [
    { … }
  ],
  "update_subscription_plans": [
    { … }
  ],
  "metrics": [
    "billing_documents",
    "delta_metrics"
  ]
}

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

{
  "actions": [
    { … },
    { … }
  ],
  "billing_documents": [
    { … },
    { … }
  ]
}