--- title: "Retrieve the status and response of a job" method: GET path: "/v1/async-jobs/{jobId}" tags: ["Orders"] --- # Retrieve the status and response of a job `GET /v1/async-jobs/{jobId}` **Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. **Note:** The [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature to access the [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature enabled by default. Get the status and response of an asynchronous job. Currently, an asynchronous job created by "Create an order asynchronously" or "Preview an order asynchronously" is supported. ## Path parameters - `jobId` string, UUID, required ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Version` string ## Response `200` OK - GetAsyncOrderJobResponse - `errors` string, nullable — Error messages returned if the job failed. - `result` union - GetAsyncCreateOrderJobResponse - `processId` string — The ID of the process that handles the operation. - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`. - `code` string — The error code of response. - `message` string — The detail information of the error response - `requestId` string, uuid — Unique identifier of the request. - `success` boolean — Indicates whether the call succeeded. - `accountId` string — The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`. - `accountNumber` string — The account number for the order. - `commitments` CommitmentOutput[] — The commitments created by this order request. - `id` string — ID of the commitment - `commitmentNumber` string — Number of the commitment. - `prepaymentType` 'NotPrepaid' | 'FullyPrepaid' — The prepayment type of the commitment. - `type` 'MinCommitment' | 'MaxCommitment' — The type of the commitment. - `startDate` string, date — The start date of the commitment. - `endDate` string, date — The end date of the commitment. - `status` 'Cancel1ed' | 'Active' | 'Evaluated' | 'CancelledPendingEvaluation' — The status of the commitment. - `totalAmount` number, double — The total amount of the commitment. - `schedules` object[] — A list of Commitment schedule objects. - `id` string — The ID of the schedule. - `startDate` string — The start date of the schedule. - `endDate` string — The end date of the schedule. - `prepaymentDefinition` PrepaymentDefinition — The prepayment definition for the commitment schedule. - `prepaymentFrequency` 'Month' | 'Quarter' | 'Semi_Annual' | 'Annual' | 'Eighteen_Months' | 'Two_Years' | 'Three_Years' | 'Five_Years' | 'Specific_Months' | 'Week' | 'Specific_Weeks' | 'Specific_Days' — The prepayment frequency for the prepayment definition. If the value is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`, use the `specificFrequency` field to specify the duration. - `specificFrequency` integer — The specific frequency length. This field is required when `prepaymentFrequency` is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`. - `customFields` object — Container for custom fields of a prepayment definition object. - `totalAmount` number, double — The total amount of the schedule. - `status` 'Active' | 'Evaluated' | 'Cancelled' | 'CancelledPendingEvaluation' — The status of the schedule. - `creditMemoIds` string[] — An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the `creditMemoNumbers` field if the `returnIds` query parameter is set to `true`. - `creditMemoNumbers` string[] — An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. - `invoiceIds` string[] — An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the `invoiceNumbers` field if the `returnIds` query parameter is set to `true`. - `invoiceNumbers` string[] — An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately. - `orderId` string — The ID of the order created. This field is returned instead of the `orderNumber` field if the `returnIds` query parameter is set to `true`. - `orderLineItems` object[] — [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. **Note:** The [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature to access the [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature enabled by default. - `id` string — The sytem generated Id for the Order Line Item. - `itemNumber` string — The number for the Order Line Item. - `orderNumber` string — The order number of the order created. - `paidAmount` string — The total amount collected in this order request. - `paymentId` string — The payment Id that is collected in this order request. This field is returned instead of the `paymentNumber` field if the `returnIds` query parameter is set to `true`. - `paymentNumber` string — The payment number that is collected in this order request. - `paymentStatus` 'Error' | 'Processing' | 'Failed' — Specifies the outcome of payment collection for the order. If `collectPayment` is `true` and `allowPaymentFailure` is `true`, the order can still succeed even when payment does not, and this field shows the payment result in the response. The possible values are: * Error: Payment failed with a gateway decline, while the order, subscription, and invoice were still created successfully when `allowPaymentFailure` is `true`. * Processing: Payment was still in progress or not finalized in the response example for a simulated payment timeout, while the order succeeded. * Failed: Payment failed and the response included `paymentErrorCode` and `paymentErrorMessage`, while the order still completed successfully. - `ramps` object[] — **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature must be enabled before you can access the [Ramps](https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information coming October 2020. The ramp definitions created by this order request. - `rampNumber` string — The number of the ramp definition. - `subscriptionNumber` string — The number of the subscription that this ramp deal definition is applied to. - `refunds` object[] — Container for refunds. - `number` string — The refund number. - `refundInvoiceNumbers` string[] — An array of the refunded invoice numbers generated in this order request. - `status` 'Success' | 'Error' — The status of the refund. - `status` 'Draft' | 'Pending' | 'Completed' | 'Scheduled' — Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action. - `subscriptionIds` string[] — Container for the subscription IDs of the subscriptions in an order. This field is returned if the `returnIds` query parameter is set to `true`. - `subscriptions` object[] — This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `223.0` or a later available version. To use this field in the method, you must set the `Zuora-Version` parameter to the minor version number in the request header. Container for the subscription numbers and statuses in an order. - `status` 'Active' | 'Pending Activation' | 'Pending Acceptance' | 'Cancelled' | 'Suspended' — Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action. - `subscriptionId` string — Subscription ID of the subscription included in this order. This field is returned instead of the `subscriptionNumber` field if the `returnIds` query parameter is set to `true`. - `subscriptionNumber` string — Subscription number of the subscription included in this order. - `subscriptionOwnerId` string — Subscription owner account id of the subscription. - `subscriptionOwnerNumber` string — Subscription owner account number of the subscription. - `writeOff` object[] — Container for write-offs. - `amount` number — The amount written off from the invoice balance. - `failedReason` string — The reason of write-off failure. - `invoiceNumber` string — The number of the invoice that is written off. - `status` 'Success' | 'Failed' — The status of the write-off. - `writeOffCreditMemoNumber` string — The number of the credit memo that is written off. - `jobType` 'AsyncCreateOrder' — The type of job. - GetAsyncPreviewOrderJobResponse — The result of each type of preview. Returned only when the current request is preview call. - `processId` string — The ID of the process that handles the operation. - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`. - `code` string — The error code of response. - `message` string — The detail information of the error response - `requestId` string, uuid — Unique identifier of the request. - `success` boolean — Indicates whether the call succeeded. - `chargeMetrics` object[] - `charges` ChargePreviewMetrics[] - `chargeNumber` string - `cmrr` object - `discount` number — Total discountCmrr of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order. Only selects the applied discount charge when its endDateCondition is "Subscription_End". - `discountDelta` number — Delta discountCmrr value between the order base and the latest subscription version. - `regular` number - `regularDelta` number - `originRatePlanId` string - `productRatePlanChargeId` string - `productRatePlanId` string - `subscriptionRatePlanNumber` string — Number of a subscription rate plan for this subscription. - `tax` object - `discount` number — Total tax amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order. - `discountDelta` number — Delta discount TAX value between the base and the latest subscription version in the order for the specific recurring charge. - `regular` number - `regularDelta` number — Delta tax value between the base and the latest subscription version in the order. - `tcb` object - `discount` number — Total contract billing amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order. - `discountDelta` number — Delta discount TCB value between the base and the latest subscription version for specific recurring charge in the order. - `regular` number - `regularDelta` number — Delta TCB value between the base and the latest subscription version in the order. - `tcv` object - `discount` number — Always equals to discountTcb. - `discountDelta` number — Always equals to delta discountTcb. - `regular` number - `regularDelta` number - `subscriptionNumber` string — The number of the subscription that has been affected by this order. When creating a subscription, this value will not show if the subscription number was not specified in the request. - `creditMemos` object[] — This field is only available if you have the Invoice Settlement feature enabled. - `amount` number - `amountWithoutTax` number - `creditMemoItems` InvoiceItemPreviewResult[] - `additionalInfo` object - `numberOfDeliveries` number — The number of deliveries dedicated to the Delivery Pricing charges. **Note**: This field is available only if you have the Delivery Pricing feature enabled. - `quantity` number - `unitOfMeasure` string - `amountWithoutTax` number - `appliedToChargeNumber` string — Available when the chargeNumber of the charge that discount applies to was specified in the request or when the order is amending an existing subscription. - `chargeDescription` string - `chargeName` string - `chargeNumber` string, nullable — Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription. - `orderLineItemNumber` string, nullable — A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1". - `processingType` 'Charge' | 'Discount' | 'Tax' - `productName` string - `productRatePlanChargeId` string — The product rate plan charge ID in this `productRatePlanChargeId` field belongs to a product rate plan specified through the `subscribeToRatePlans` > `productRatePlanId` field. Therefore, this `productRatePlanChargeId` field has a value only when the `subscribeToRatePlans` > `productRatePlanId` field is specified during the subscription creation. This `productRatePlanChargeId` field does not indicate a product rate plan charge associated with an order line item. - `serviceEndDate` string, date - `serviceStartDate` string, date - `subscriptionNumber` string, nullable — The number of the subscription. - `taxAmount` number - `taxationItems` object[] — List of taxation items. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `309.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - `exemptAmount` number — The calculated tax amount excluded due to the exemption. - `id` string — The ID of the taxation item. - `jurisdiction` string — The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. - `locationCode` string — The identifier for the location based on the value of the taxCode field. - `name` string — The name of the taxation item. - `taxAmount` number — The amount of the tax applied to the invoice. - `taxCode` string — The tax code identifies which tax rules and tax rates to apply to a specific invoice. - `taxCodeDescription` string — The description of the tax code. - `taxDate` string — The date when the tax is applied to the invoice. - `taxRate` number — The tax rate applied to the invoice. - `taxRateDescription` string — The description of the tax rate. - `taxRateType` 'Percentage' | 'FlatFee' — Enum:"Percentage" "FlatFee". The type of the tax rate applied to the invoice. - `unitPrice` number — The per-unit price of the invoice item. - `targetDate` string, date - `taxAmount` number - `invoices` object[] - `amount` number — The total amount of the invoice. - `amountWithoutTax` number — The amount of the invoice without tax. - `invoiceItems` InvoiceItemPreviewResult[] — The invoice items on the invoice. - `additionalInfo` object - `numberOfDeliveries` number — The number of deliveries dedicated to the Delivery Pricing charges. **Note**: This field is available only if you have the Delivery Pricing feature enabled. - `quantity` number - `unitOfMeasure` string - `amountWithoutTax` number - `appliedToChargeNumber` string — Available when the chargeNumber of the charge that discount applies to was specified in the request or when the order is amending an existing subscription. - `chargeDescription` string - `chargeName` string - `chargeNumber` string, nullable — Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription. - `orderLineItemNumber` string, nullable — A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1". - `processingType` 'Charge' | 'Discount' | 'Tax' - `productName` string - `productRatePlanChargeId` string — The product rate plan charge ID in this `productRatePlanChargeId` field belongs to a product rate plan specified through the `subscribeToRatePlans` > `productRatePlanId` field. Therefore, this `productRatePlanChargeId` field has a value only when the `subscribeToRatePlans` > `productRatePlanId` field is specified during the subscription creation. This `productRatePlanChargeId` field does not indicate a product rate plan charge associated with an order line item. - `serviceEndDate` string, date - `serviceStartDate` string, date - `subscriptionNumber` string, nullable — The number of the subscription. - `taxAmount` number - `taxationItems` object[] — List of taxation items. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `309.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - `exemptAmount` number — The calculated tax amount excluded due to the exemption. - `id` string — The ID of the taxation item. - `jurisdiction` string — The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. - `locationCode` string — The identifier for the location based on the value of the taxCode field. - `name` string — The name of the taxation item. - `taxAmount` number — The amount of the tax applied to the invoice. - `taxCode` string — The tax code identifies which tax rules and tax rates to apply to a specific invoice. - `taxCodeDescription` string — The description of the tax code. - `taxDate` string — The date when the tax is applied to the invoice. - `taxRate` number — The tax rate applied to the invoice. - `taxRateDescription` string — The description of the tax rate. - `taxRateType` 'Percentage' | 'FlatFee' — Enum:"Percentage" "FlatFee". The type of the tax rate applied to the invoice. - `unitPrice` number — The per-unit price of the invoice item. - `targetDate` string, date — The target date to bill the invoice. - `taxAmount` number — The total tax amount of the invoice. - `invoiceItemSummary` InvoiceItemSummary[] — The aggregated summary data for all future invoices to be billed within the preview period. This field is returned only if you set the `summarizeInvoiceItem` query parameter to `true`. - `previewInvoiceSequence` number — The sequence number of the invoice to be billed. - `subTotal` number, double — The aggregated subtotal amount of the invoice. - `discountAmount` number, double — The aggregated discount amount of the invoice. - `taxAmount` number, double — The aggregated tax amount of the invoice. - `total` number, double — The aggregated total amount of the invoice. - `servicePeriodStartDate` string, date — The start date of the period being billed. - `servicePeriodEndDate` string, date — The end date of the period being billed. - `orderDeltaMetrics` object — **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://docs.zuora.com?resourceId=billing-overview-orders). The new methodologies are reflected in the following Order Delta Metrics objects. * [Order Delta Mrr](https://docs.zuora.com?resourceId=billing-order-delta-mrr) * [Order Delta Tcv](https://docs.zuora.com?resourceId=billing-order-delta-tcv) * [Order Delta Tcb](https://docs.zuora.com?resourceId=billing-order-delta-tcb) It is recommended that all customers use the new [Order Delta Metrics](https://docs.zuora.com?resourceId=billing-order-delta-metrics). If you are an existing [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). - `orderDeltaMrr` OrderDeltaMrr[] - `chargeNumber` string — The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item. - `currency` string — ISO 3-letter currency code (uppercase). For example, USD. - `endDate` string, date — The end date for the order delta metric. - `grossAmount` number — The gross amount for the metric. The is the amount excluding applied discount. - `netAmount` number — The net amount for the metric. The is the amount with discounts applied - `orderActionId` string — The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderActionSequence` string — The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderActionType` string — The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderLineItemNumber` string — A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1". - `productRatePlanChargeId` string — The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge. - `ratePlanChargeId` string — The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item. - `startDate` string, date — The start date for the order delta metric. - `subscriptionNumber` string — The number of the subscription. This field can be null if the metric is generated for an Order Line Item. - `orderDeltaTcb` OrderDeltaTcb[] - `chargeNumber` string — The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item. - `currency` string — ISO 3-letter currency code (uppercase). For example, USD. - `endDate` string, date — The end date for the order delta metric. - `grossAmount` number — The gross amount for the metric. The is the amount excluding applied discount. - `netAmount` number — The net amount for the metric. The is the amount with discounts applied - `orderActionId` string — The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderActionSequence` string — The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderActionType` string — The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderLineItemNumber` string — A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1". - `productRatePlanChargeId` string — The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge. - `ratePlanChargeId` string — The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item. - `startDate` string, date — The start date for the order delta metric. - `subscriptionNumber` string — The number of the subscription. This field can be null if the metric is generated for an Order Line Item. - `orderLineItemId` string, UUID — The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for a Rate Plan Charge. - `orderDeltaTcv` OrderDeltaTcv[] - `chargeNumber` string — The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item. - `currency` string — ISO 3-letter currency code (uppercase). For example, USD. - `endDate` string, date — The end date for the order delta metric. - `grossAmount` number — The gross amount for the metric. The is the amount excluding applied discount. - `netAmount` number — The net amount for the metric. The is the amount with discounts applied - `orderActionId` string — The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderActionSequence` string — The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderActionType` string — The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item. - `orderLineItemNumber` string — A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1". - `productRatePlanChargeId` string — The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge. - `ratePlanChargeId` string — The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item. - `startDate` string, date — The start date for the order delta metric. - `subscriptionNumber` string — The number of the subscription. This field can be null if the metric is generated for an Order Line Item. - `orderLineItemId` string, UUID — The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for subscriptions. - `orderMetrics` object[] — **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://docs.zuora.com?resourceId=billing-overview-orders). The new methodologies are reflected in the following Order Delta Metrics objects. * [Order Delta Mrr](https://docs.zuora.com?resourceId=billing-order-delta-mrr) * [Order Delta Tcv](https://docs.zuora.com?resourceId=billing-order-delta-tcv) * [Order Delta Tcb](https://docs.zuora.com?resourceId=billing-order-delta-tcb) It is recommended that all customers use the new [Order Delta Metrics](https://docs.zuora.com?resourceId=billing-order-delta-metrics). If you are an existing [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). Whereas new customers, and existing customers not currently on [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported. - `orderActions` object[] - `orderItems` OrderItem[] — The `orderItems` nested field is only available to existing Orders customers who already have access to the field. **Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://docs.zuora.com?resourceId=billing-orders-harmonization) will not get these metrics. * The Order ELP and Order Item objects * The "Generated Reason" and "Order Item ID" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects Zuora no longer provides product support, and bug fixes or security issues are no longer addressed. - `endDate` string, date — The order item's effective end date, aligned with the end date of an increased quantity order metrics. - `id` string — The ID of the order item. - `orderActionId` string — Specify the order action that creates this order item. - `quantity` number — The order item quantity. For the usage charge type, the value of this field is always zero. Also, the Owner Transfer order action always creates an order item whose Quantity field is zero. - `scId` string — The ID of the charge segment that gets newly generated when the order item is created. - `startDate` string, date — The order item's effective start date, aligned with the start date of an increased quantity order metrics. - `orderMetrics` OrderMetric[] — The container for order metrics. **Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://docs.zuora.com?resourceId=billing-orders-harmonization) will not get these metrics. * The Order ELP and Order Item objects * The "Generated Reason" and "Order Item ID" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects Zuora no longer provides product support, and bug fixes or security issues are no longer addressed. - `chargeNumber` string - `elp` TimeSlicedElpNetMetrics[] — The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity. The `elp` nested field is only available to existing Orders customers who already have access to the field. **Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://docs.zuora.com?resourceId=billing-orders-harmonization) will not get these metrics. * The Order ELP and Order Item objects * The "Generated Reason" and "Order Item ID" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects Zuora no longer provides product support, and bug fixes or security issues are no longer addressed. - … - `mrr` TimeSlicedNetMetrics[] - … - `originRatePlanId` string - `productRatePlanChargeId` string - `productRatePlanId` string - `subscriptionRatePlanNumber` string — Number of a subscription rate plan for this subscription. - `quantity` TimeSlicedMetrics[] - … - `tcb` TimeSlicedTcbNetMetrics[] — Total contracted billing which is the forecast value for the total invoice amount. - … - `tcv` TimeSlicedNetMetrics[] — Total contracted value. - … - `sequence` string - `type` string - `subscriptionNumber` string - `rampMetrics` OrderRampMetrics[] — **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature must be enabled before you can access the [Ramps](https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information coming October 2020. The ramp metrics. - `description` string — The short description of the ramp. - `discountTcb` number — The discount amount for the TCB. - `discountTcv` number — The discount amount for the TCV. - `grossTcb` number — The gross TCB value before discount charges are applied. - `grossTcv` number — The gross TCV value before discount charges are applied. - `intervals` OrderRampIntervalMetrics[] — The ramp metrics for each ramp intervals in its timeline. - `description` string — The short description of the interval. - `discountTcb` number — The discount amount for the TCB. - `discountTcv` number — The discount amount for the TCV. - `endDate` string, date — The end date of the interval. - `grossTcb` number — The gross TCB value before discount charges are applied. - `grossTcv` number — The gross TCV value before discount charges are applied. - `intervalDeltaMetrics` RampIntervalChargeDeltaMetrics[] — Container for the delta metrics for each rate plan charge in each ramp interval. The delta is the difference of the subscription metrics between before and after the order. - `chargeNumber` string — The number of the rate plan charge. - `deltaDiscountTcb` number — The discount delta amount for the TCB. - `deltaDiscountTcv` number — The discount delta amount for the TCV. - `deltaGrossTcb` number — The TCB delta value before discount charges are applied. - `deltaGrossTcv` number — The TCV delta value before discount charges are applied. - `deltaMrr` object[] — The MRR changing history of the current rate plan charge in the current ramp interval. - … - `deltaNetTcb` number — The TCB delta value after discount charges are applied. - `deltaNetTcv` number — The TCV delta value after discount charges are applied. - `deltaQuantity` object[] — The charge quantity changing history of the current rate plan charge in the current ramp interval. - … - `productRatePlanChargeId` string — The ID of the corresponding product rate plan charge. - `subscriptionNumber` string — The number of the subscription that the current rate plan charge belongs to. - `intervalMetrics` RampIntervalChargeMetrics[] — Container for the detailed metrics for each rate plan charge in each ramp interval. - `chargeNumber` string — The number of the charge. - `discountTcb` number — The discount amount for the TCB. - `discountTcv` number — The discount amount for the TCV. - `endDate` string, date — The end date of the rate plan charge in the current ramp interval. - `grossTcb` number — The gross TCB value before discount charges are applied. - `grossTcv` number — The gross TCV value before discount charges are applied. - `mrr` object[] — The MRR changing history of the current rate plan charge in the current ramp interval. - … - `netTcb` number — The net TCB value after discount charges are applied. - `netTcv` number — The net TCV value after discount charges are applied. - `productRatePlanChargeId` string — The ID of the corresponding product rate plan charge. - `quantity` number — The quantity of the rate plan charge. - `ratePlanChargeId` string — The ID of the rate plan charge. - `startDate` string, date — The start date of the rate plan charge in the current ramp interval. - `subscriptionNumber` string — The number of the subscription that the current rate plan charge belongs to. - `name` string — The name of the interval. - `netTcb` number — The net TCB value after discount charges are applied. - `netTcv` number — The net TCV value after discount charges are applied. - `startDate` string, date — The start date of the interval. - `name` string — The name of the ramp. - `netTcb` number — The net TCB value after discount charges are applied. - `netTcv` number — The net TCV value after discount charges are applied. - `number` string — The number of the ramp. It is automaticcally generated by the billing system. - `jobType` 'AsyncPreviewOrder' — The type of job. - `status` 'Processing' | 'Failed' | 'Completed' — Type of job status. - `success` boolean — Indicates whether the operation call succeeded. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)