# Preview an existing subscription You can preview the billing document metrics or the order delta metrics across a specified time frame. Endpoint: POST /subscriptions/{subscription_id}/preview Version: 2025-11-12 Security: bearerAuth ## Path parameters: - `subscription_id` (string, required) Identifier for the subscription, either subscription_number or subscription_id ## 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) 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 fields (application/json): - `custom_fields` (object) Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. - `description` (string) Description of the subscription. - `account_id` (string) Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. - `account_number` (string) Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. - `account_data` (object) 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. - `account_data.sold_to` (object) Customer address used for calculating tax. - `account_data.sold_to.address` (object) Container for the address informtion. - `account_data.sold_to.address.line1` (string) Address line 1 (e.g., street, PO Box, or company name). Example: "3333 Piedmont Rd NE" - `account_data.sold_to.address.line2` (string) Address line 2 (e.g., apartment, suite, unit, or building). Example: "Suite 1150" - `account_data.sold_to.address.city` (string) City, district, suburb, town, or village. Example: "Atlanta" - `account_data.sold_to.address.state` (string) State or providence Example: "GA" - `account_data.sold_to.address.country` (string) The country of the contact's address. Example: "United States" - `account_data.sold_to.address.county` (string) Zuora Tax uses this information to calculate county taxation. - `account_data.sold_to.address.postal_code` (string) ZIP or postal code. Example: "30305" - `account_data.sold_to.first_name` (string, required) Customer first name. Example: "Amy" - `account_data.sold_to.home_phone` (string) Customer home phone (including extension). Example: "(888)976-9056" - `account_data.sold_to.last_name` (string, required) Customer last name. Example: "Lawrence" - `account_data.sold_to.mobile_phone` (string) Customer phone (including extension). Example: "(888)101-0011" - `account_data.sold_to.nickname` (string) Nickname for this contact. Example: "Ami" - `account_data.sold_to.other_phone` (string) Other customer phone (including extension). Example: "(888)100-0001" - `account_data.sold_to.email` (string) Customer email address. Example: "alawrence@gmail.com" - `account_data.sold_to.tax_region` (string) A region defined in your Zuora Tax rules. Example: "Georgia" - `account_data.sold_to.work_email` (string) Customer work email. Example: "alawrence@zuora.com" - `account_data.sold_to.work_phone` (string) Customer work phone. Example: "(888)976-9056" - `account_data.sold_to.other_phone_type` (string) The type of the additional phone number. Enum: "work", "mobile", "home", "other" - `account_data.sold_to.fax` (string) The contact's fax number. - `account_data.tax_certificate` (object) The tax certificate information. - `account_data.tax_certificate.company_code` (string) Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on country of origin and sold-to addresses in Avalara. Example: "ABC" - `account_data.tax_certificate.id` (string) Identifier of the tax exemption certificate. - `account_data.tax_certificate.start_date` (string) The tax certificate start date. Example: "2022-01-01" - `account_data.tax_certificate.description` (string) Description of the tax exemption certificate. - `account_data.tax_certificate.entity_use_code` (string) A unique entity use code used by Avalara to apply exemptions. This field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/) for more information. - `account_data.tax_certificate.end_date` (string) The tax certificate end date. Example: "2023-01-01" - `account_data.tax_certificate.issuing_jurisdiction` (string) Typically, this is a state or government agency Example: "Georgia" - `account_data.tax_certificate.state` (string) Status of the tax exemption certificate, indication whether the certificate has been verified. Enum: "pending", "verified", "not_valid" - `account_data.tax_certificate.tax_identifier` (string) Value Added Tax (VAT) ID. Each VAT ID must begin with the code of the country code and followed by a block of digits or characters. Example: "DE123456789" - `account_data.bill_cycle_day` (integer, required) The day of the month on which your customer will be invoiced. For month-end specify 31. - `account_data.currency` (string, required) Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated. Example: "USD" - `account_data.tax_identifier` (object) An object that contains the VAT Identification number. - `account_data.tax_identifier.id` (string) Value Added Tax (VAT) ID. Each VAT ID must begin with the code of the country code and followed by a block of digits or characters. - `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) Specifies the metrics you want to preview. You can preview metrics of billing documents, the order delta metrics, or both. Enum: "billing_documents", "delta_metrics" - `end_date` (string) End date of the period for which you want to preview the subscription - `add_subscription_plans` (array) Specify this field if you want to add one or multiple subscription plans to this subscription. - `add_subscription_plans.subscription_plan` (object, required) Subscription plan information. - `add_subscription_plans.subscription_plan.plan_id` (string) Identifier of the plan associated with this subscription plan. Note: You can add up to 30 plan_id in a single call. - `add_subscription_plans.subscription_plan.plan_number` (string) Human-readable identifier of the plan associated with this subscription plan. - `add_subscription_plans.subscription_plan.prices` (array) Price information within the subscription plan. - `add_subscription_plans.subscription_plan.prices.price_id` (string, required) Identifier of the price. - `add_subscription_plans.subscription_plan.prices.subscription_item_number` (string) Human-readable identifier of the subscription item. It can be user-supplied. - `add_subscription_plans.subscription_plan.prices.description` (string) Description of the price. Often useful for displaying to users. - `add_subscription_plans.subscription_plan.prices.recurring` (object) The recurring components of a price such as interval and usage. - `add_subscription_plans.subscription_plan.prices.recurring.recurring_on` (string) Specifies on which day or the month or day of the week a customer shall be billed. Enum: "_1", "_2", "_3", "_4", "_5", "_6", "_7", "_8", "_9", "_10", "_11", "_12", "_13", "_14", "_15", "_16", "_17", "_18", "_19", "_20", "_21", "_22", "_23", "_24", "_25", "_26", "_27", "_28", "_29", "_30", "_31", "subscription_item_start_day", "account_cycle_date", "subscription_start_day", "term_start_day", "term_end_day", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" - `add_subscription_plans.subscription_plan.prices.recurring.usage` (boolean) Indicates that this is a usage price. - `add_subscription_plans.subscription_plan.prices.recurring.interval` (string) Specifies the billing frequency. One of week, month or year. Enum: "month", "year", "week", "term", "day" - `add_subscription_plans.subscription_plan.prices.recurring.interval_count` (integer) The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and intervalCount=3 bills every 3 months. - `add_subscription_plans.subscription_plan.prices.recurring.alignment_behavior` (string) Specifies how to align billing for recurring (subscription) products that start on different days. Enum: "subscription_start", "term_start", "term_end", "none" - `add_subscription_plans.subscription_plan.prices.recurring.timing` (string) You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. Enum: "in_advance", "in_arrears" - `add_subscription_plans.subscription_plan.prices.recurring.duration_interval` (string) Specifies the duration frequency. One of day, week, month or year. Enum: "day", "week", "month", "year", "subscription_term", "billing_period" - `add_subscription_plans.subscription_plan.prices.recurring.duration_interval_count` (integer) Specifies how long a customer shall be charged if this is less than the duration of the subscription - `add_subscription_plans.subscription_plan.prices.recurring.rating_group` (string) A rating group based on which usage records are rated. Only applicable to usage prices. Enum: "billing_period", "usage_start_date", "usage_record", "usage_upload", "custom_group" - `add_subscription_plans.subscription_plan.prices.recurring.on` (string) Specifies on which day or the month or day of the week a customer shall be billed. Enum: "_1", "_2", "_3", "_4", "_5", "_6", "_7", "_8", "_9", "_10", "_11", "_12", "_13", "_14", "_15", "_16", "_17", "_18", "_19", "_20", "_21", "_22", "_23", "_24", "_25", "_26", "_27", "_28", "_29", "_30", "_31", "subscription_item_start_day", "account_cycle_date", "subscription_start_day", "term_start_day", "term_end_day", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" - `add_subscription_plans.subscription_plan.prices.start_event` (string) Specifies when to start billing your customer. Enum: "contract_effective", "service_activation", "customer_acceptance", "specific_date" - `add_subscription_plans.subscription_plan.prices.start_date` (string) The date when the subscription item starts - `add_subscription_plans.subscription_plan.prices.end_date` (string) The date when the subscription item ends or ended. - `add_subscription_plans.subscription_plan.prices.tiers_mode` (string) Specifies the mode of tiering. Enum: "graduated", "volume", "high_watermark_volume", "high_watermark_graduated", "graduated_with_overage" - `add_subscription_plans.subscription_plan.prices.tiers` (array) Information of all tiers if the price is a tiered price. - `add_subscription_plans.subscription_plan.prices.tiers.up_to` (number) Specifies the upper bound of the tier. The lower bound of a tier is the upper bound of the previous tier plus one. - `add_subscription_plans.subscription_plan.prices.tiers.amount` (number) The amount of the price. Specify this field if you want to override the original price with a flat-fee price. - `add_subscription_plans.subscription_plan.prices.tiers.unit_amount` (number) The unit amount of the price. Specify this field if you want to override the original price with a per-unit price. - `add_subscription_plans.subscription_plan.prices.quantity` (number) Quantity of the product to which your customers subscribe. - `add_subscription_plans.subscription_plan.prices.amount` (number) The amount of the price. Specify this field if you want to override the original price with a flat-fee price - `add_subscription_plans.subscription_plan.prices.discount_amount` (number) Discount amount. Specify this field if you offer an amount-based discount. - `add_subscription_plans.subscription_plan.prices.discount_percent` (number) Discount percent. Specify this field if you offer a percentage-based discount. - `add_subscription_plans.subscription_plan.prices.price_base_interval` (string) Specifies the base interval of the price the subscriber is subscribed to. If not provided, this field defaults to billing_period. Enum: "month", "billing_period", "week" - `add_subscription_plans.subscription_plan.prices.overage` (object) An object defining how overage charges are calculated. - `add_subscription_plans.subscription_plan.prices.overage.interval_count` (integer) Specifies the number of intervals used to calculate smoothed overage charges. - `add_subscription_plans.subscription_plan.prices.overage.type` (string) Represents the overage type: one of rolling_window or rollover. Enum: "rolling_window", "rollover" - `add_subscription_plans.subscription_plan.prices.overage.included_units` (number) Specifies the included units to which overage charges do not apply. - `add_subscription_plans.subscription_plan.prices.overage.credit_unused_units` (boolean) Specifies whether or not to credit unused units. - `add_subscription_plans.subscription_plan.prices.overage.apply_at_end_of_smoothing_period` (boolean) Indicates if the overage price is calculated at the end of the smoothing period. - `add_subscription_plans.subscription_plan.prices.unique_token` (string) Unique identifier for the price. This identifier enables you to refer to the price before the price has an internal identifier in Zuora. - `add_subscription_plans.subscription_plan.prices.apply_discount_to` (array) Any combination of one-time, recurring, and usage. Enum: "one_time", "recurring", "usage" - `add_subscription_plans.subscription_plan.prices.discount_level` (string) Specifies at what level a discount should be applied: one of account, subscription or plan. Enum: "account", "subscription", "plan" - `add_subscription_plans.subscription_plan.prices.custom_field_per_unit_rate` (string) Name of the custom field that will be used to set a per unit rate under the Pre-Rated Per Unit charge model - `add_subscription_plans.subscription_plan.prices.custom_field_total_amount` (string) Name of the custom field that will be used to set a total amount under the Pre-Rated charge model - `add_subscription_plans.subscription_plan.prices.price_change_percentage` (number) The percentage to increase or decrease the price of a termed subscription's renewal. - `add_subscription_plans.subscription_plan.prices.price_change_option` (string) Applies an automatic price change when a termed subscription is renewed. Enum: "latest_catalog_pricing", "percentage", "none" - `add_subscription_plans.subscription_plan.prices.prepayment` (object) The prepayment information. - `add_subscription_plans.subscription_plan.prices.prepayment.quantity` (number) The number of units included in a prepayment charge. - `add_subscription_plans.subscription_plan.prices.prepayment.validity_period` (string) The period in which the prepayment units are valid to use as defined in a prepayment charge. Enum: "subscription_term", "annual", "semi_annual", "quarter", "month" - `add_subscription_plans.subscription_plan.prices.drawdown` (object) The drawdown information. - `add_subscription_plans.subscription_plan.prices.drawdown.conversion_rate` (number) The conversion rate between usage unit of measure (UOM) and drawdown unit of measure for a drawdown charge. Note: Must be a positive number (>0). Must be 1 when usage UOM and drawdown UOM are the same. If both conversion_rate and unit_of_measure for the drawdown are empty, the system will set default values respectively: conversion_rate: 1 unit_of_measure: Same as the usage UOM of this drawdown charge. The conversion_rate and unit_of_measure fields need to have values or be empty at the same time. - `add_subscription_plans.subscription_plan.unique_token` (string) Unique identifier for the subscription plan. This identifier enables you to refer to the subscription plan before the subscription plan has an internal identifier in Zuora. - `add_subscription_plans.start_on` (object) 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](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) 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](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) 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](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) 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](https://support.zuora.com/). add_subscription_plans update_subscription_plans remove_subscription_plans renew terms If [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) 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](https://support.zuora.com/). add_subscription_plans update_subscription_plans remove_subscription_plans renew terms - `add_subscription_plans.start_on.contract_effective` (string, required) Effective contract date for this subscription, in the yyyy-mm-dd format. Example: "2023-06-01" - `add_subscription_plans.start_on.service_activation` (string) The date on which the services or products within a subscription have been activated and access has been provided to the customer, as the yyyy-mm-dd format. If [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) 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 service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) 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](https://support.zuora.com/). add_subscription_plans update_subscription_plans remove_subscription_plans renew terms Example: "2023-06-01" - `add_subscription_plans.start_on.customer_acceptance` (string) The date on which the services or products within a subscription have been accepted by the customer, in the yyyy-mm-dd format. If [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) 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 customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) 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](https://support.zuora.com/). add_subscription_plans update_subscription_plans remove_subscription_plans renew terms Example: "2023-06-01" - `add_subscription_plans.change_reason` (string) A brief description of the reason for this change. - `replace_subscription_plans` (array) 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. - `replace_subscription_plans.subscription_plan_id` (string) Identifier of the subscription plan. Only provide one of previous_plan_id or subscription_plan_id in your request, not both. - `replace_subscription_plans.previous_plan_id` (string) Identifier of the plan to be removed. Only provide one of previous_plan_id or subscription_plan_id in your request, not both. - `replace_subscription_plans.replace_at` (string) The default value for the replace_at field is as follows: If the subscription plan change (from old to new) is an upgrade, the replace_at is now by default. If the subscription change (from old to new) is a downgrade, the replace_at is end_of_billing_period by default. Otherwise, the replace_at is specific_date by default. Notes: When setting this field to end_of_billing_period, you cannot set the billing start dates for the subscription as the system will automatically set the start dates to the end of billing period, and you cannot set the following billing trigger date settings to Yes: Require Customer Acceptance of Orders Require Service Activation of Orders When setting this field to specific_date, you must also specify a date for the contract_effective date in the start_on field. Enum: "now", "end_of_billing_period", "specific_date" - `replace_subscription_plans.replacement_type` (string) Enum: "upgrade", "downgrade", "crossgrade", "other" - `update_subscription_plans` (array) - `update_subscription_plans.subscription_plan` (object, required) Subscription Plan information. - `update_subscription_plans.subscription_plan.subscription_plan_id` (string) Identifier of the subscription plan. - `update_subscription_plans.subscription_plan.subscription_items` (array) Subscription item information. - `update_subscription_plans.subscription_plan.subscription_items.id` (string) Identifier of the subscription item. - `update_subscription_plans.subscription_plan.subscription_items.subscription_item_number` (string) Human-readable identifier of the subscription. It can be user-supplied. - `update_subscription_plans.subscription_plan.subscription_items.description` (string) An arbitrary string attached to the object. Often useful for displaying to users. - `update_subscription_plans.subscription_plan.subscription_items.apply_discount_to` (array) Any combination of one-time, recurring, or usage prices. Enum: "one_time", "recurring", "usage" - `update_subscription_plans.subscription_plan.subscription_items.discount_level` (string) Specifies at what level a discount should be applied. Enum: "account", "subscription", "plan" - `update_subscription_plans.subscription_plan.subscription_items.discount_percent` (number) Discount percent. Specify this field if you want to override with a discount-based discount price. - `update_subscription_plans.subscription_plan.subscription_items.unit_amount` (number) The unit amount of the price. Specify this field if you want to override the orignial price with a per-unit price. - `update_subscription_plans.subscription_plan.subscription_items.tiers` (array) Information of all tiers if you want to override the original price with a tiered price. - `update_subscription_plans.start_date` (string) The start date from which this order action becomes effective. Example: "2022-01-01" - `remove_subscription_plans` (array) Specify this field if you want to remove one or multiple subscription plans from this subscription. ## Response 200 fields (application/json): - `actions` (array) - `actions.action_id` (string) Identifier of the action. - `actions.action` (string) The action associated with this metric. Enum: "create_subscription", "terms", "add_subscription_plan", "update_subscription_plan", "remove_subscription_plan", "renew", "cancel", "owner_transfer", "pause", "resume", "replace_subscription_plan" - `actions.sequence` (integer) The sequence number of the action. - `actions.subscription_items` (array) - `actions.subscription_items.subscription_item_id` (string) Identifier of the subscription item. - `actions.subscription_items.price_id` (string) Identifier of the price. - `actions.subscription_items.start_date` (string) Date on which the subscription item starts to become effective. - `actions.subscription_items.end_date` (string) Date on which the subscription item expires. - `actions.subscription_items.mrr` (object) - `actions.subscription_items.mrr.gross_amount` (number) - `actions.subscription_items.mrr.net_amount` (number) - `actions.subscription_items.mrr.currency` (string) - `actions.subscription_items.tcb` (object) - `actions.subscription_items.tcv` (object) - `billing_documents` (array) - `billing_documents.subtotal` (number) The total amount exclusive of tax. - `billing_documents.tax` (number) The total tax amount. - `billing_documents.total` (number) The total amount. - `billing_documents.type` (string) The type of billing document. Can be one of the credit memo, debit memo, or invoice. Enum: "credit_memo", "debit_memo", "invoice" - `billing_documents.target_date` (string) - `billing_documents.billing_document_items` (array) - `billing_documents.billing_document_items.subscription_item_description` (string) - `billing_documents.billing_document_items.subscription_item_name` (string) - `billing_documents.billing_document_items.subscription_item_number` (string) - `billing_documents.billing_document_items.processing_type` (string) Enum: "subscription_item", "discount", "prepayment", "tax" - `billing_documents.billing_document_items.product_name` (string) - `billing_documents.billing_document_items.price_id` (string) The identifier of the price this billing document item is associated with. - `billing_documents.billing_document_items.service_end_date` (string) The end date of the service period associated with this billing document item. If the associated charge is a one-time fee, then this date is the date of that charge. - `billing_documents.billing_document_items.service_start_date` (string) The start date of the service period associated with this billing document item. If the associated charge is a one-time fee, then this date is the date of that charge. - `billing_documents.billing_document_items.tax` (number) The amount of tax applied to the billing document item. - `billing_documents.billing_document_items.quantity` (number) The number of units of this item. - `billing_documents.billing_document_items.unit_of_measure` (string) Specifies the units used to measure usage. - `billing_documents.billing_document_items.subtotal` (number) The total amount of this billing document item exclusive of tax. - `billing_documents.billing_document_items.total` (number) The total amount of this billing document item. - `billing_documents.billing_document_items.taxation_items` (array) - `billing_documents.billing_document_items.taxation_items.amount_exempt` (number) The calculated tax amount excluded due to the exemption. - `billing_documents.billing_document_items.taxation_items.id` (string) Identifier of the taxation item related to the invoice. Only applicable for credit memos created from invoices. - `billing_documents.billing_document_items.taxation_items.jurisdiction` (string) The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. - `billing_documents.billing_document_items.taxation_items.location_code` (string) The identifier for the location based on the value of the tax_code field. - `billing_documents.billing_document_items.taxation_items.name` (string) The name of the taxation item. - `billing_documents.billing_document_items.taxation_items.amount` (number) The amount of the tax applied to the total price. - `billing_documents.billing_document_items.taxation_items.tax_code` (string) A tax code identifier. If a tax_code of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. - `billing_documents.billing_document_items.taxation_items.tax_code_name` (string) The amount of the tax applied to the total price. - `billing_documents.billing_document_items.taxation_items.date` (string) The date on which the tax is applied. Example: "2022-01-01" - `billing_documents.billing_document_items.taxation_items.tax_rate` (number) The amount of the tax applied to the total price. - `billing_documents.billing_document_items.taxation_items.tax_rate_name` (string) The name of the tax rate, such as sales tax or GST. This name is displayed on billing documents. - `billing_documents.billing_document_items.taxation_items.tax_rate_type` (string) Indicates whether the tax rate is an amount or a percentage. Enum: "percent", "amount" ## Response 400 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 401 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 404 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 405 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 429 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 500 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 502 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 503 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean) ## Response 504 fields (application/json): - `type` (string) - `errors` (array) - `errors.code` (string) - `errors.parameter` (string) - `errors.message` (string) - `retryable` (boolean)