Resubmit the request first to have another try.
If this error still occurs, contact Zuora Global Support with the returned `Zuora-Request-Id` value in the response header for assistance.
|\n| 60 | Internal error | The server encounters an internal error. | Contact Zuora Global Support with the returned `Zuora-Request-Id` value in the response header for assistance. |\n| 61 | Temporary error | A temporary error occurs during request processing, for example, a database communication error. |Resubmit the request first to have another try.
If this error still occurs, contact Zuora Global Support with the returned `Zuora-Request-Id` value in the response header for assistance.
|\n| 70 | Request exceeded limit | The total number of concurrent requests exceeds the limit allowed by the system. |Resubmit the request after the number of seconds specified by the `Retry-After` value in the response header.
Check [Concurrent request limits](/rest-api/general-concepts/rate-concurrency-limits/) for details about Zuora’s concurrent request limit policy.
|\n| 90 | Malformed request | The request cannot be processed due to JSON syntax errors. | Check the syntax error in the JSON request body and ensure that the request is in the correct JSON format. |\n| 99 | Integration error | The server encounters an error when communicating with an external system, for example, payment gateway, tax engine provider. | Check the response message and take action accordingly. |\n\n\n# API Versions\n\nThe Zuora REST API are version controlled. Versioning ensures that Zuora REST API changes are backward compatible. Zuora uses a major and minor version nomenclature to manage changes. By specifying a version in a REST request, you can get expected responses regardless of future changes to the API.\n\n## Major Version\n\nThe major version number of the REST API appears in the REST URL. In this API reference, only the **v1** major version is available. For example, `POST https://rest.zuora.com/v1/subscriptions`.\n\n## Minor Version\n\nZuora uses minor versions for the REST API to control small changes. For example, a field in a REST method is deprecated and a new field is used to replace it. \n\nSome fields in the REST methods are supported as of minor versions. If a field is not noted with a minor version, this field is available for all minor versions. If a field is noted with a minor version, this field is in version control. You must specify the supported minor version in the request header to process without an error. \n\nIf a field is in version control, it is either with a minimum minor version or a maximum minor version, or both of them. You can only use this field with the minor version between the minimum and the maximum minor versions. For example, the `invoiceCollect` field in the POST Subscription method is in version control and its maximum minor version is 189.0. You can only use this field with the minor version 189.0 or earlier.\n\nIf you specify a version number in the request header that is not supported, Zuora will use the minimum minor version of the REST API. In our REST API documentation, if a field or feature requires a minor version number, we note that in the field description.\n\nYou only need to specify the version number when you use the fields require a minor version. To specify the minor version, set the `zuora-version` parameter to the minor version number in the request header for the request call. For example, the `collect` field is in 196.0 minor version. If you want to use this field for the POST Subscription method, set the `zuora-version` parameter to `196.0` in the request header. The `zuora-version` parameter is case sensitive.\n\nFor all the REST API fields, by default, if the minor version is not specified in the request header, Zuora will use the minimum minor version of the REST API to avoid breaking your integration. \n\n### Minor Version History\n\nThe supported minor versions are not consecutive. \nYou can use the following versions to override the default version (`186.0`):\n - 187.0\n - 188.0\n - 189.0\n - 196.0\n - 206.0\n - 207.0\n - 211.0\n - 214.0\n - 215.0\n - 216.0\n - 223.0\n - 224.0\n - 230.0\n - 239.0\n - 256.0\n - 257.0\n - 309.0\n - 314.0\n - 315.0\n - 329.0\n - 330.0\n - 336.0\n - 337.0\n - 338.0\n - 341.0\n\nIf you set the `zuora-version` header to a version excluded from the preceding list, the corresponding API request is processed as you use the default version, `186.0`.\n\nThe following table lists the supported versions and the fields that have a Zuora REST API minor version.\n\n| Fields | Minor Version | REST Methods | Description |\n|:--------|:--------|:--------|:--------|\n| invoiceCollect | 189.0 and earlier | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice and collects a payment for a subscription. |\n| collect | 196.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Collects an automatic payment for a subscription. |\n| invoice | 196.0 and 207.0| [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice for a subscription. |\n| invoiceTargetDate | 206.0 and earlier | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\") |Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| invoiceTargetDate | 207.0 and earlier | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| targetDate | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\") |Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| targetDate | 211.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| includeExisting DraftInvoiceItems | 206.0 and earlier| [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | Specifies whether to include draft invoice items in subscription previews. Specify it to be `true` (default) to include draft invoice items in the preview result. Specify it to be `false` to excludes draft invoice items in the preview result. |\n| includeExisting DraftDocItems | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | Specifies whether to include draft invoice items in subscription previews. Specify it to be `true` (default) to include draft invoice items in the preview result. Specify it to be `false` to excludes draft invoice items in the preview result. |\n| previewType | 206.0 and earlier| [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | The type of preview you will receive. The possible values are `InvoiceItem`(default), `ChargeMetrics`, and `InvoiceItemChargeMetrics`. |\n| previewType | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | The type of preview you will receive. The possible values are `LegalDoc`(default), `ChargeMetrics`, and `LegalDocChargeMetrics`. |\n| runBilling | 211.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice or credit memo for a subscription. **Note:** Credit memos are only available if you have the Invoice Settlement feature enabled. |\n| invoiceDate | 214.0 and earlier | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date that should appear on the invoice being generated, as `yyyy-mm-dd`. |\n| invoiceTargetDate | 214.0 and earlier | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date through which to calculate charges on this account if an invoice is generated, as `yyyy-mm-dd`. |\n| documentDate | 215.0 and later | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date that should appear on the invoice and credit memo being generated, as `yyyy-mm-dd`. |\n| targetDate | 215.0 and later | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date through which to calculate charges on this account if an invoice or a credit memo is generated, as `yyyy-mm-dd`. |\n| memoItemAmount | 223.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | Amount of the memo item. |\n| amount | 224.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | Amount of the memo item. |\n| subscriptionNumbers | 222.4 and earlier | [Create order](/api-references/api/operation/POST_Order \"Create order\") | Container for the subscription numbers of the subscriptions in an order. |\n| subscriptions | 223.0 and later | [Create order](/api-references/api/operation/POST_Order \"Create order\") | Container for the subscription numbers and statuses in an order. |\n| creditTaxItems | 238.0 and earlier | [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\") | Container for the taxation items of the credit memo item. |\n| taxItems | 238.0 and earlier | [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Container for the taxation items of the debit memo item. |\n| taxationItems | 239.0 and later | [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Container for the taxation items of the memo item. |\n| chargeId | 256.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | ID of the product rate plan charge that the memo is created from. |\n| productRatePlanChargeId | 257.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | ID of the product rate plan charge that the memo is created from. |\n| comment | 256.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\"); [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice \"Create credit memo from invoice\"); [Create debit memo from invoice](/api-references/api/operation/POST_DebitMemoFromInvoice \"Create debit memo from invoice\"); [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Comments about the product rate plan charge, invoice item, or memo item. |\n| description | 257.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\"); [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice \"Create credit memo from invoice\"); [Create debit memo from invoice](/api-references/api/operation/POST_DebitMemoFromInvoice \"Create debit memo from invoice\"); [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Description of the the product rate plan charge, invoice item, or memo item. |\n| taxationItems | 309.0 and later | [Preview an order](/api-references/api/operation/POST_PreviewOrder \"Preview an order\") | List of taxation items for an invoice item or a credit memo item. |\n| batch | 309.0 and earlier | [Create a billing preview run](/api-references/api/operation/POST_BillingPreviewRun \"Create a billing preview run\") | The customer batches to include in the billing preview run. | \n| batches | 314.0 and later | [Create a billing preview run](/api-references/api/operation/POST_BillingPreviewRun \"Create a billing preview run\") | The customer batches to include in the billing preview run. |\n| taxationItems | 315.0 and later | [Preview a subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview a subscription\"); [Update a subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update a subscription\")| List of taxation items for an invoice item or a credit memo item. |\n| billingDocument | 330.0 and later | [Create a payment schedule](/api-references/api/operation/POST_PaymentSchedule \"Create a payment schedule\"); [Create multiple payment schedules at once](/api-references/api/operation/POST_PaymentSchedules \"Create multiple payment schedules at once\")| The billing document with which the payment schedule item is associated. |\n| paymentId | 336.0 and earlier | [Add payment schedule items to a custom payment schedule](/api-references/api/operation/POST_AddItemsToCustomPaymentSchedule/ \"Add payment schedule items to a custom payment schedule\"); [Update a payment schedule](/api-references/api/operation/PUT_PaymentSchedule/ \"Update a payment schedule\"); [Update a payment schedule item](/api-references/api/operation/PUT_PaymentScheduleItem/ \"Update a payment schedule item\"); [Preview the result of payment schedule update](/api-references/api/operation/PUT_PaymentScheduleUpdatePreview/ \"Preview the result of payment schedule update\"); [Retrieve a payment schedule](/api-references/api/operation/GET_PaymentSchedule/ \"Retrieve a payment schedule\"); [Retrieve a payment schedule item](/api-references/api/operation/GET_PaymentScheduleItem/ \"Retrieve a payment schedule item\"); [List payment schedules by customer account](/api-references/api/operation/GET_PaymentSchedules/ \"List payment schedules by customer account\"); [Cancel a payment schedule](/api-references/api/operation/PUT_CancelPaymentSchedule/ \"Cancel a payment schedule\"); [Cancel a payment schedule item](/api-references/api/operation/PUT_CancelPaymentScheduleItem/ \"Cancel a payment schedule item\");[Skip a payment schedule item](/api-references/api/operation/PUT_SkipPaymentScheduleItem/ \"Skip a payment schedule item\");[Retry failed payment schedule items](/api-references/api/operation/POST_RetryPaymentScheduleItem/ \"Retry failed payment schedule items\") | ID of the payment to be linked to the payment schedule item.\n\n\n#### Version 207.0 and Later\n\nThe response structure of the [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription) and [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") methods are changed. The following invoice related response fields are moved to the invoice container:\n\n * amount\n * amountWithoutTax\n * taxAmount\n * invoiceItems\n * targetDate\n * chargeMetrics\n\n\n# API Names for Zuora Objects\n\nFor information about the Zuora business object model, see [Zuora Business Object Model](/rest-api/general-concepts/object-model/).\n\nYou can use the [Describe](/api-references/api/operation/GET_Describe) operation to list the fields of each Zuora object that is available in your tenant. When you call the operation, you must specify the API name of the Zuora object.\n\nThe following table provides the API name of each Zuora object:\n\n| Object | API Name |\n|-----------------------------------------------|--------------------------------------------|\n| Account | `Account` |\n| Accounting Code | `AccountingCode` |\n| Accounting Period | `AccountingPeriod` |\n| Amendment | `Amendment` |\n| Application Group | `ApplicationGroup` |\n| Billing Run |`BillingRun` - API name used in the [Describe](/api-references/api/operation/GET_Describe) operation, Export ZOQL queries, and Data Query.
`BillRun` - API name used in the [Actions](/v1-api-reference/api/Actions). See the CRUD oprations of [Bill Run](/v1-api-reference/api/Bill-Run) for more information about the `BillRun` object. `BillingRun` and `BillRun` have different fields. | \n| Billing Preview Run | `BillingPreviewRun` | \n| Configuration Templates | `ConfigurationTemplates` |\n| Contact | `Contact` |\n| Contact Snapshot | `ContactSnapshot` |\n| Credit Balance Adjustment | `CreditBalanceAdjustment` |\n| Credit Memo | `CreditMemo` |\n| Credit Memo Application | `CreditMemoApplication` |\n| Credit Memo Application Item | `CreditMemoApplicationItem` |\n| Credit Memo Item | `CreditMemoItem` |\n| Credit Memo Part | `CreditMemoPart` |\n| Credit Memo Part Item | `CreditMemoPartItem` |\n| Credit Taxation Item | `CreditTaxationItem` |\n| Custom Exchange Rate | `FXCustomRate` |\n| Debit Memo | `DebitMemo` |\n| Debit Memo Item | `DebitMemoItem` |\n| Debit Taxation Item | `DebitTaxationItem` |\n| Discount Applied Metrics | `DiscountAppliedMetrics` |\n| Entity | `Tenant` |\n| Fulfillment | `Fulfillment` |\n| Feature | `Feature` |\n| Gateway Reconciliation Event | `PaymentGatewayReconciliationEventLog` |\n| Gateway Reconciliation Job | `PaymentReconciliationJob` |\n| Gateway Reconciliation Log | `PaymentReconciliationLog` |\n| Invoice | `Invoice` |\n| Invoice Adjustment | `InvoiceAdjustment` |\n| Invoice Item | `InvoiceItem` |\n| Invoice Item Adjustment | `InvoiceItemAdjustment` |\n| Invoice Payment | `InvoicePayment` |\n| Invoice Schedule | `InvoiceSchedule` |\n| Invoice Schedule Item | `InvoiceScheduleItem` |\n| Journal Entry | `JournalEntry` |\n| Journal Entry Item | `JournalEntryItem` |\n| Journal Run | `JournalRun` |\n| Notification History - Callout | `CalloutHistory` |\n| Notification History - Email | `EmailHistory` |\n| Offer | `Offer` |\n| Order | `Order` |\n| Order Action | `OrderAction` |\n| Order ELP | `OrderElp` |\n| Order Line Items | `OrderLineItems` | \n| Order Item | `OrderItem` |\n| Order MRR | `OrderMrr` |\n| Order Quantity | `OrderQuantity` |\n| Order TCB | `OrderTcb` |\n| Order TCV | `OrderTcv` |\n| Payment | `Payment` |\n| Payment Application | `PaymentApplication` |\n| Payment Application Item | `PaymentApplicationItem` |\n| Payment Method | `PaymentMethod` |\n| Payment Method Snapshot | `PaymentMethodSnapshot` |\n| Payment Method Transaction Log | `PaymentMethodTransactionLog` |\n| Payment Method Update | `UpdaterDetail` |\n| Payment Part | `PaymentPart` |\n| Payment Part Item | `PaymentPartItem` |\n| Payment Run | `PaymentRun` |\n| Payment Transaction Log | `PaymentTransactionLog` |\n| Price Book Item | `PriceBookItem` |\n| Processed Usage | `ProcessedUsage` |\n| Product | `Product` |\n| Product Charge Definition | `ProductChargeDefinition` | \n| Product Feature | `ProductFeature` |\n| Product Rate Plan | `ProductRatePlan` |\n| Product Rate Plan Definition | `ProductRatePlanDefinition` | \n| Product Rate Plan Charge | `ProductRatePlanCharge` |\n| Product Rate Plan Charge Tier | `ProductRatePlanChargeTier` |\n| Rate Plan | `RatePlan` |\n| Rate Plan Charge | `RatePlanCharge` |\n| Rate Plan Charge Tier | `RatePlanChargeTier` |\n| Refund | `Refund` |\n| Refund Application | `RefundApplication` |\n| Refund Application Item | `RefundApplicationItem` |\n| Refund Invoice Payment | `RefundInvoicePayment` |\n| Refund Part | `RefundPart` |\n| Refund Part Item | `RefundPartItem` |\n| Refund Transaction Log | `RefundTransactionLog` |\n| Revenue Charge Summary | `RevenueChargeSummary` |\n| Revenue Charge Summary Item | `RevenueChargeSummaryItem` |\n| Revenue Event | `RevenueEvent` |\n| Revenue Event Credit Memo Item | `RevenueEventCreditMemoItem` |\n| Revenue Event Debit Memo Item | `RevenueEventDebitMemoItem` |\n| Revenue Event Invoice Item | `RevenueEventInvoiceItem` |\n| Revenue Event Invoice Item Adjustment | `RevenueEventInvoiceItemAdjustment` |\n| Revenue Event Item | `RevenueEventItem` |\n| Revenue Event Item Credit Memo Item | `RevenueEventItemCreditMemoItem` |\n| Revenue Event Item Debit Memo Item | `RevenueEventItemDebitMemoItem` |\n| Revenue Event Item Invoice Item | `RevenueEventItemInvoiceItem` |\n| Revenue Event Item Invoice Item Adjustment | `RevenueEventItemInvoiceItemAdjustment` |\n| Revenue Event Type | `RevenueEventType` |\n| Revenue Schedule | `RevenueSchedule` |\n| Revenue Schedule Credit Memo Item | `RevenueScheduleCreditMemoItem` |\n| Revenue Schedule Debit Memo Item | `RevenueScheduleDebitMemoItem` |\n| Revenue Schedule Invoice Item | `RevenueScheduleInvoiceItem` |\n| Revenue Schedule Invoice Item Adjustment | `RevenueScheduleInvoiceItemAdjustment` |\n| Revenue Schedule Item | `RevenueScheduleItem` |\n| Revenue Schedule Item Credit Memo Item | `RevenueScheduleItemCreditMemoItem` |\n| Revenue Schedule Item Debit Memo Item | `RevenueScheduleItemDebitMemoItem` |\n| Revenue Schedule Item Invoice Item | `RevenueScheduleItemInvoiceItem` |\n| Revenue Schedule Item Invoice Item Adjustment | `RevenueScheduleItemInvoiceItemAdjustment` |\n| Subscription | `Subscription` |\n| Subscription Product Feature | `SubscriptionProductFeature` |\n| Taxable Item Snapshot | `TaxableItemSnapshot` |\n| Taxation Item | `TaxationItem` |\n| Updater Batch | `UpdaterBatch` |\n| Usage | `Usage` |\n"
contact:
email: docs@zuora.com
host: rest.zuora.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Orders
description: "Orders are contractual agreements between merchants and customers. \n\nFor more information about Orders, see Orders.\n"
paths:
/v1/orders/preview:
post:
summary: Preview an order
operationId: POST_PreviewOrder
description: "**Notes**:\n - This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n - The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n - You cannot preview offers through this operation.\n - You cannot preview enhanced discounts. \n\nRetrieves the preview of the charge metrics and invoice items of a specified order. Preview for subscriptions and order line items are both supported. This operation is only an order preview and no order is created. \n\nYou can also use this operation to preview billing for a standalone order. For more information, see Preview billing for a standalone order. The Standalone Orders feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](https://support.zuora.com).\n\n#### Billing preview behavior regarding draft invoices\nBy default, the billing preview behavior regarding draft invoices is as below:\n* When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded.\n* When you preview billing for your order and the order contains order line items only, the draft invoices are included.\n* When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items.\n\nHowever, if you want to always exclude the draft invoices in billing preview, submit a request at [Zuora Global Support](https://support.zuora.com).\n\n#### Limits on Orders API\nThe limit of orders allowed on a subscription is 1000.\n\nThe limit of order line items allowed in an order is 100.\n\nZuora has the following limits on the Orders synchronous API to prevent performance degradation: \n* Up to 50 subscriptions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed on a single subscription in a [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n\nIf you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:\n* [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously)\n* [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously)\n* [Retrieve the status and response of a job](/v1-api-reference/api/orders/get_jobstatusandresponse) for checking the status of the asynchronous API operations\n\nZuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:\n* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/POSTOrderPreviewRequestType'
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/PostOrderPreviewResponseType'
examples:
application/json:
success: true
previewResult:
chargeMetrics:
- subscriptionNumber: A-S00000101
charges:
- productRatePlanId: 2c98901f6706718c016706b8c0720012
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
originRatePlanId: 2c98919c67a5ae9d0167a6901c5a027f
chargeNumber: C-00000211
cmrr:
regular: 30
discount: null
regularDelta: 0
discountDelta: null
tcv:
regular: 11.61
discount: null
regularDelta: -348.39
discountDelta: null
tcb:
regular: 11.61
discount: null
regularDelta: -348.39
discountDelta: null
- subscriptionNumber: A-S00000100
charges:
- productRatePlanId: 2c98901f6706718c016706b8c0720012
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
originRatePlanId: 2c98919c67a5ae9d0167a68f8eb20262
chargeNumber: C-00000210
cmrr:
regular: 40
discount: null
regularDelta: 10
discountDelta: null
tcv:
regular: 480
discount: null
regularDelta: 120
discountDelta: null
tcb:
regular: 480
discount: null
regularDelta: 120
discountDelta: null
- subscriptionNumber: A-S00000102
charges:
- productRatePlanId: 2c98901f6706718c016706b8c0720012
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
originRatePlanId: 2c98919c67a5ae9d0167a69089bd029c
chargeNumber: C-00000212
cmrr:
regular: 30
discount: null
regularDelta: 30
discountDelta: null
tcv:
regular: 359.61
discount: null
regularDelta: 348
discountDelta: null
tcb:
regular: 360
discount: null
regularDelta: 348.39
discountDelta: null
invoices:
- amount: 141.93
amountWithoutTax: 141.93
taxAmount: 0
targetDate: '2019-01-01'
invoiceItems:
- serviceStartDate: '2018-12-01'
serviceEndDate: '2018-12-12'
amountWithoutTax: 11.61
taxAmount: 0
chargeDescription: ''
chargeName: Charge
chargeNumber: C-00000212
processingType: Charge
productName: Product
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
subscriptionNumber: A-S00000102
additionalInfo:
quantity: 2
unitOfMeasure: Each
numberOfDeliveries: 2
- serviceStartDate: '2018-12-23'
serviceEndDate: '2018-12-31'
amountWithoutTax: 8.71
taxAmount: 0
chargeDescription: ''
chargeName: Charge
chargeNumber: C-00000212
processingType: Charge
productName: Product
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
subscriptionNumber: A-S00000102
additionalInfo:
quantity: 2
unitOfMeasure: Each
numberOfDeliveries: 2
- serviceStartDate: '2019-01-01'
serviceEndDate: '2019-01-31'
amountWithoutTax: 30
taxAmount: 0
chargeDescription: ''
chargeName: Charge
chargeNumber: C-00000212
processingType: Charge
productName: Product
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
subscriptionNumber: A-S00000102
additionalInfo:
quantity: 2
unitOfMeasure: Each
numberOfDeliveries: 2
- serviceStartDate: '2018-12-01'
serviceEndDate: '2018-12-12'
amountWithoutTax: 11.61
taxAmount: 0
chargeDescription: ''
chargeName: Charge
chargeNumber: C-00000211
processingType: Charge
productName: Product
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
subscriptionNumber: A-S00000101
additionalInfo:
quantity: 2
unitOfMeasure: Each
numberOfDeliveries: 2
- serviceStartDate: '2018-12-01'
serviceEndDate: '2018-12-31'
amountWithoutTax: 40
taxAmount: 0
chargeDescription: ''
chargeName: Charge
chargeNumber: C-00000210
processingType: Charge
productName: Product
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
subscriptionNumber: A-S00000100
additionalInfo:
quantity: 2
unitOfMeasure: Each
numberOfDeliveries: 2
- serviceStartDate: '2019-01-01'
serviceEndDate: '2019-01-31'
amountWithoutTax: 40
taxAmount: 0
chargeDescription: ''
chargeName: Charge
chargeNumber: C-00000210
processingType: Charge
productName: Product
productRatePlanChargeId: 2c98901f6706718c016706b91c6e001f
subscriptionNumber: A-S00000100
additionalInfo:
quantity: 2
unitOfMeasure: Each
numberOfDeliveries: 2
orderDeltaMetrics:
orderDeltaMrr:
- subscriptionNumber: A-S00000100
orderActionId: 4028818475f8cfd5017608b0a0d303d2
orderActionType: CreateSubscription
orderActionSequence: 0
chargeNumber: C-00000210
productRatePlanChargeId: 4028818278829c7b01788313e5d704d4
ratePlanChargeId: 4028818475f8cfd5017608b0a2aa03de
startDate: '2020-01-01'
endDate: '2021-01-01'
currency: USD
grossAmount: 100.0
netAmount: 80.0
orderDeltaTcv:
- subscriptionNumber: A-S00000100
orderActionId: 4028818475f8cfd5017608b0a0d303d2
orderActionType: CreateSubscription
orderActionSequence: 0
chargeNumber: C-00000210
productRatePlanChargeId: 4028818278829c7b01788313e5d704d4
ratePlanChargeId: 4028818475f8cfd5017608b0a2aa03de
startDate: '2020-01-01'
endDate: '2021-01-01'
currency: USD
grossAmount: 1200.0
netAmount: 960.0
- orderLineItemId: 69ee0828eb844c7e8ae66dbe3ef68dc4
productRatePlanChargeId: 4028818475f8cfd5017608b0a2aa03de
startDate: '2020-01-01'
endDate: '2020-01-02'
currency: USD
orderLineItemNumber: '1'
grossAmount: 565.0
netAmount: 565.0
orderDeltaTcb:
- subscriptionNumber: A-S00000100
orderActionId: 4028818475f8cfd5017608b0a0d303d2
orderActionType: CreateSubscription
orderActionSequence: 0
chargeNumber: C-00000210
productRatePlanChargeId: 4028818278829c7b01788313e5d704d4
ratePlanChargeId: 4028818475f8cfd5017608b0a2aa03de
startDate: '2020-01-01'
endDate: '2021-01-01'
currency: USD
grossAmount: 1200.0
netAmount: 960.0
- orderLineItemId: 69ee0828eb844c7e8ae66dbe3ef68dc4
productRatePlanChargeId: 4028818475f8cfd5017608b0a2aa03de
startDate: '2020-01-01'
endDate: '2020-01-02'
currency: USD
orderLineItemNumber: '1'
grossAmount: 565.0
netAmount: 565.0
/v1/async/orders/preview:
post:
summary: Preview an order asynchronously
operationId: POST_PreviewOrderAsynchronously
description: "**Notes:** \n- This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August 2020). 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.\n- The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n- You cannot preview offers through this operation.\n- You cannot preview enhanced discounts.\n\nIn the case where a normal \"Preview an order\" operation call will time out, use this operation instead to preview an order asynchronously. A job will be previewing the order in the back end; the job ID will be returned for tracking the job status and result.\n\n#### Billing preview behavior regarding draft invoices\nBy default, the billing preview behavior regarding draft invoices is as below:\n* When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded.\n* When you preview billing for your order and the order contains order line items only, the draft invoices are included.\n* When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items.\n\nHowever, if you want to always exclude the draft invoices in billing preview, submit a request at [Zuora Global Support](https://support.zuora.com).\n\n#### Limits on Orders API\n\nThe limit of orders allowed on a subscription is 1000.\n\nThe limit of order line items allowed in an order is 100.\n\nZuora has the following limits on the Orders synchronous API to prevent performance degradation: \n* Up to 50 subscriptions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed on a single subscription in a [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n\nIf you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:\n* [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously)\n* [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously)\n* [Retrieve the status and response of a job](/v1-api-reference/api/orders/get_jobstatusandresponse) for checking the status of the asynchronous API operations\n\nZuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:\n* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/POSTOrderPreviewAsyncRequestType'
responses:
202:
description: Accepted
examples:
application/json:
jobId: 2c90a02d676688200167770ce20601b6
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
Location:
type: string
description: URL for accessing the job result, in the format of `/async-jobs/{jobId}`. For example, `/async-jobs/2c90a02d676688200167770ce20601b6`
schema:
type: object
properties:
jobId:
type: string
format: UUID
description: The ID of an asynchronous job that will be returned for tracking the status and result of the job.
/v1/orders:
post:
summary: Create an order
operationId: POST_Order
description: "**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nYou can use this operation to create subscriptions and make changes to subscriptions by creating orders. You can also use this operation to create order line items by creating orders. The following tutorials demonstrate how to use this operation:\n\n * [Create a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/A_Create_a_Subscription)\n * [Add a Product to a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/A_Add_a_Product_to_a_Subscription)\n * [Create a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/B_Create_a_Ramp_Deal)\n * [Add a Product Mid-Interval Update on a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/E_Update_a_Product_in_a_Ramp_Deal)\n * [Add a Product in a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/C_Add_a_Product_in_a_Ramp_Deal)\n * [Change the Terms and Conditions of a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/D_Change_the_Terms_and_Conditions_of_a_Ramp_Deal_and_Update_the_Ramp)\n * [Change the Owner of a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Change_the_Owner_of_a_Subscription)\n * [Change the Terms and Conditions of a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Change_the_Terms_and_Conditions_of_a_Subscription)\n * [Renew a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Renew_a_Subscription)\n * [Renew a Subscription and Upgrade a Product](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Renew_a_Subscription_and_Upgrade_a_Product)\n * [Replace a Product in a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Replace_a_Product_in_a_Subscription)\n * [Update a Product in a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription)\n * [Cancel a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/D_Cancel_a_Subscription)\n * [Remove a Product from a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/D_Remove_a_Product_from_a_Subscription)\n * [Create sales order line items](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/AA_Create_a_sales_order_line_item_with_fulfillments)\n * [Associate order line items with new subscriptions](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/C_Associate_an_order_line_item_with_a_new_subscription)\n * [Return order line items](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/DA_Return_an_order_line_item_with_fulfillments)\n\nYou can also use this operation to create orders and save the orders as scehduled orders. The Scheduled Orders feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.\n\nIn addition, you can use this operation to place a standalone order to subscribe without pre-defining a product catalog in Zuora Billing. For more information, see Create a subscription using a standalone order. The Standalone Orders feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](https://support.zuora.com).\n\n**Note:** If you received a timeout error message when creating an order, the call is still running in the backend and the order will be created.\n\nThe limit of orders allowed on a subscription is 1000.\n\nThe limit of order line items allowed in an order is 100.\n\nZuora has the following limits on the Orders synchronous API to prevent performance degradation: \n* Up to 50 subscriptions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed on a single subscription in a [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n\nIf you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:\n* [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously)\n* [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously)\n* [Retrieve the status and response of a job](/v1-api-reference/api/orders/get_jobstatusandresponse) for checking the status of the asynchronous API operations\n\nZuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:\n* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n\n\n**Note:** When you are to suspend a subcription (via the `suspend` order action), if in the same \"Create an order\" call you are to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription (via a `resume` order action). \n\n**Note:** When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- type: boolean
in: query
description: 'Specify whether to return IDs associated with the numbers returned in the "Create an order" operation.
'
name: returnIds
required: false
default: false
- name: zuora-version
in: header
required: false
type: string
description: "\nThe minor version of the Zuora REST API. \n\nYou need to set this parameter if you use the following fields:\n* subscriptions\n* subscriptionNumbers\n"
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/POSTOrderRequestType'
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
examples:
application/json:
success: true
orderNumber: OM-00002
accountNumber: A00000001
status: Pending
subscriptions:
- subscriptionNumber: SM-00001
status: Pending Activation
- subscriptionNumber: SM-00002
status: Pending Acceptance
- subscriptionNumber: SM-00003
status: Active
- subscriptionNumber: SM-00004
status: Pending Acceptance
- subscriptionNumber: SM-00005
status: Suspended
- subscriptionNumber: SM-00006
status: Active
invoiceNumbers:
- INV00000001
paymentNumber: P-00000002
paidAmount: 300
orderLineItems:
- id: bd78c0522adf42c2aa0fccacc997fa20
itemNumber: '116'
schema:
$ref: '#/definitions/PostOrderResponseType'
get:
summary: List orders
operationId: GET_AllOrders
description: "**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nRetrieves information about all orders in your tenant. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned. \nBy default, it returns the first page of the orders. \n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/parameters/GLOBAL_REQUEST_page'
- $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
- name: dateFilterOption
in: query
description: 'The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.
'
required: false
type: string
- name: startDate
in: query
description: 'The result will only contain the orders with the date of dateFilterOption later than or equal to this date.
'
required: false
type: string
format: date
- name: endDate
in: query
description: 'The result will only contains orders with the date of dateFilterOption earlier than or equal to this date.
'
required: false
type: string
format: date
- name: status
in: query
description: The status of orders.
required: false
type: string
enum:
- all
- cancelled
- completed
- draft
- executing
- failed
- pending
- scheduled
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/GetAllOrdersResponseType'
examples:
application/json:
orders:
- orderNumber: O-00000002
orderDate: '2017-03-01'
createdDate: '2018-03-14 15:12:58'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
description: This is a description for the Order.
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: null
baseVersion: 1
newVersion: 2
orderActions:
- type: UpdateProduct
sequence: 0
triggerDates:
- triggerDate: '2017-03-01'
name: ContractEffective
- triggerDate: '2017-03-01'
name: ServiceActivation
- triggerDate: '2017-03-01'
name: CustomerAcceptance
updateProduct:
ratePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
specificUpdateDate: null
newRatePlanId: 2c989028622282520162235ada870649
chargeUpdates:
- description: null
chargeNumber: C-00000001
uniqueToken: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
quantity: 7
tiers: []
priceChangeOption: null
priceIncreasePercentage: null
effectiveDate:
specificTriggerDate: null
billing:
billingPeriodAlignment: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: null
orderLineItems:
- id: 4028fc827a0e48c1017a0e4dccc60002
orderId: 4028fc827a0e48c1017a0e58b9330014
itemName: webcam
itemNumber: '1'
itemState: Executing
itemType: Product
description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.
purchaseOrderNumber: 960-000764
productCode: C9201
amount: 10000
amountWithoutTax: 10000
quantity: 2
amountPerUnit: 5000
listPricePerUnit: 59
listPrice: 118
billTargetDate: null
soldTo: 4028fc828244a0ac018244dfc9a90bee
soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
ownerAccountId: ff80808187ff38570187ff433f974203
ownerAccountNumber: AN_1683614809986
ownerAccountName: AC_AC_16836148099861683614809986
invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
invoiceOwnerAccountNumber: AN_1683614809001
invoiceOwnerAccountName: AC_AC_16836148090011683614809001
transactionStartDate: '2021-02-01'
transactionEndDate: '2021-02-01'
accountingCode: null
UOM: null
productRatePlanChargeId: null
customFields:
orderLineItemCF__c: olinumber-023
customFields:
order_cf_date__c: '2017-01-01'
- orderNumber: O-00000001
orderDate: '2017-01-01'
createdDate: '2018-03-14 15:12:55'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: sub123
baseVersion: null
newVersion: 1
orderActions:
- type: CreateSubscription
sequence: 0
triggerDates:
- triggerDate: '2017-01-01'
name: ContractEffective
- triggerDate: '2017-01-01'
name: ServiceActivation
- triggerDate: '2017-01-01'
name: CustomerAcceptance
createSubscription:
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
renewalSetting: RENEW_WITH_SPECIFIC_TERM
initialTerm:
startDate: '2017-01-01'
period: 12
periodType: Month
termType: TERMED
renewalTerms:
- period: 0
periodType: Month
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- productRatePlanId: 2c989028622282520162235ac91605b3
newRatePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
chargeOverrides:
- description: null
chargeNumber: C-00000001
productRateplanChargeId: 2c989028622282520162235aca7a05b9
uniqueToken: null
pricing:
recurringVolume:
quantity: 12
tiers: []
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
startDate:
specificTriggerDate: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
billing:
billCycleDay: null
billingPeriod: null
billCycleType: null
billingTiming: null
billingPeriodAlignment: null
specificBillingPeriod: null
weeklyBillCycleDay: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
order_cf_date__c: '2017-01-01'
success: true
/v1/async/orders:
post:
summary: Create an order asynchronously
operationId: POST_CreateOrderAsynchronously
description: "**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nIn the case where a normal \"Create an order\" operation call will time out, use this operation instead to create an order asynchronously. A job will be creating the order in the back end; the job ID will be returned for tracking the job status and result. \n\nNote that this operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the \"Create an order\" operation instead.\n\nThe limit of orders allowed on a subscription is 1000.\n\nThe limit of order line items allowed in an order is 100.\n\nZuora has the following limits on the Orders synchronous API to prevent performance degradation: \n* Up to 50 subscriptions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed in a single [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n* Up to 50 order actions are allowed on a single subscription in a [Create an order](/api-references/api/operation/POST_Order) or [Preview an order](/api-references/api/operation/POST_PreviewOrder) operation call.\n\nIf you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:\n* [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously)\n* [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously)\n* [Retrieve the status and response of a job](/v1-api-reference/api/orders/get_jobstatusandresponse) for checking the status of the asynchronous API operations\n\nZuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:\n* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed in a single [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- type: boolean
in: query
description: 'Specify whether to return IDs for the [Get job status and response](/v1-api-reference/api/orders/get_jobstatusandresponse) operation. If you set this query parameter to `true`, the corresponding IDs, which are associated with the numbers returned in this operation, can be returned in the "Get job status and response" response body.
'
name: returnIds
required: false
default: false
- name: zuora-version
in: header
required: false
type: string
description: "\nThe minor version of the Zuora REST API. \n\nYou need to set this parameter if you want to use the following fields:\n* subscriptions\n* subscriptionNumbers\n* subscriptionIds (when the `returnId` query parameter is set to `true`)\n"
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/POSTOrderAsyncRequestType'
responses:
202:
description: Accepted
examples:
application/json:
jobId: 1bc24f315d7b48d3a20245bfe73bdceb
success: 'true'
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
Location:
type: string
description: URL for accessing the job result, in the format of `/async-jobs/{jobId}`. For example, `/async-jobs/1bc24f315d7b48d3a20245bfe73bdceb`
schema:
type: object
properties:
jobId:
type: string
format: UUID
description: The ID of an asynchronous job that will be returned for tracking the status and result of the job.
success:
type: boolean
description: Indicates whether the operation call succeeded.
/v1/orders/{orderNumber}:
get:
summary: Retrieve an order
operationId: GET_Order
description: "**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nRetrieves the detailed information about a specified order.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: The order number to be retrieved.
required: true
type: string
format: string
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/GetOrderResponse'
examples:
application/json:
success: true
order:
orderNumber: O-00000282
orderDate: '2018-10-01'
createdDate: '2018-12-13 17:21:43'
createdBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2018-12-13 17:21:45'
updatedBy: 402881e522cf4f9b0122cf5d82860002
existingAccountNumber: A00000101
currency: USD
status: Completed
description: This is a description for the Order.
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
subscriptions:
- subscriptionNumber: A-S00000100
subscriptionOwnerAccountNumber: A00000001
externallyManagedBy: null
customFields: {}
baseVersion: 1
newVersion: 2
orderActions:
- type: UpdateProduct
sequence: 0
triggerDates:
- triggerDate: '2018-12-01'
name: ContractEffective
- triggerDate: '2018-12-01'
name: ServiceActivation
- triggerDate: '2018-12-01'
name: CustomerAcceptance
updateProduct:
ratePlanId: 2c98919c67a5ae9d0167a68f8eb20262
uniqueToken: null
specificUpdateDate: null
newRatePlanId: 2c98919c67a5ae9d0167a6df3011036e
chargeUpdates:
- description: null
chargeNumber: C-00000210
uniqueToken: null
newRatePlanChargeId: 2c98919c67a5ae9d0167a6df304b0372
pricing:
recurringPerUnit:
listPrice: 20
quantity: null
priceChangeOption: null
priceIncreasePercentage: null
effectiveDate:
specificTriggerDate: null
billing:
billingPeriodAlignment: null
customFields: {}
customFields: {}
customFields: {}
- subscriptionNumber: A-S00000101
subscriptionOwnerAccountNumber: A00000001
externallyManagedBy: null
customFields: {}
baseVersion: 1
newVersion: 2
orderActions:
- type: Suspend
sequence: 0
triggerDates:
- triggerDate: '2018-12-01'
name: ContractEffective
- triggerDate: '2018-12-01'
name: ServiceActivation
- triggerDate: '2018-12-01'
name: CustomerAcceptance
suspend:
suspendPolicy: Today
suspendPeriods: null
suspendPeriodsType: null
suspendSpecificDate: null
suspendDate: '2018-12-13'
customFields: {}
- subscriptionNumber: A-S00000102
subscriptionOwnerAccountNumber: A00000001
externallyManagedBy: null
customFields: {}
baseVersion: 2
newVersion: 3
orderActions:
- type: Resume
sequence: 0
triggerDates:
- triggerDate: '2018-12-12'
name: ContractEffective
- triggerDate: '2018-12-12'
name: ServiceActivation
- triggerDate: '2018-12-12'
name: CustomerAcceptance
resume:
resumePolicy: FixedPeriodsFromSuspendDate
resumePeriods: 10
resumePeriodsType: Day
resumeSpecificDate: null
extendsTerm: true
resumeDate: '2018-12-23'
customFields: {}
- type: TermsAndConditions
sequence: 1
triggerDates:
- triggerDate: '2018-12-12'
name: ContractEffective
- triggerDate: '2018-12-12'
name: ServiceActivation
- triggerDate: '2018-12-12'
name: CustomerAcceptance
termsAndConditions:
autoRenew: null
renewalSetting: null
initialTerm:
startDate: null
period: 375
periodType: Day
termType: null
renewalTerms:
- period: null
periodType: null
customFields: {}
orderLineItems:
- id: 4028fc827a0e48c1017a0e4dccc60002
orderId: 4028fc827a0e48c1017a0e58b9330014
itemName: webcam
itemNumber: '1'
itemState: Executing
itemType: Product
description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.
purchaseOrderNumber: 960-000764
productCode: C9201
amount: 10000
amountWithoutTax: 10000
quantity: 2
amountPerUnit: 5000
listPricePerUnit: 59
listPrice: 118
billTargetDate: null
soldTo: 4028fc828244a0ac018244dfc9a90bee
soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
ownerAccountId: ff80808187ff38570187ff433f974203
ownerAccountNumber: AN_1683614809986
ownerAccountName: AC_AC_16836148099861683614809986
invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
invoiceOwnerAccountNumber: AN_1683614809001
invoiceOwnerAccountName: AC_AC_16836148090011683614809001
transactionStartDate: '2021-02-01'
transactionEndDate: '2021-02-01'
accountingCode: null
UOM: null
productRatePlanChargeId: null
customFields:
orderLineItemCF__c: olinumber-023
customFields: {}
delete:
tags:
- Orders
summary: Delete an order
description: "**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nDeletes a specified order. \n\n* All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version. \n\n* All the order line items created in this order are deleted.\n\nYou are not allowed to delete an order if the charges that are affected by this order are invoiced.\n"
operationId: DELETE_Order
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: The number of the order to be deleted.
required: true
type: string
format: string
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/CommonResponseType'
examples:
application/json:
success: true
put:
tags:
- Orders
summary: Update an order
operationId: PUT_Order
description: "**Notes:** \n- This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n- Update an order is only valid for draft or scheduled orders. The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.\n- This operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the \"Create an order\" operation instead.\n- You must provide full payload when using the \"Update an order\" operation. That is, if you want to edit one order action, you need to provide all other order actions in the payload. Otherwise, the other order actions will be removed.\n"
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: Order number of a order in which you are to update.
required: true
type: string
format: string
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/PUTOrderRequestType'
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/PostOrderResponseType'
examples:
application/json:
success: true
orderNumber: OM-00002
accountNumber: A00000001
status: Pending
subscriptions:
- subscriptionNumber: SM-00001
status: Pending Activation
- subscriptionNumber: SM-00002
status: Pending Acceptance
- subscriptionNumber: SM-00003
status: Active
- subscriptionNumber: SM-00004
status: Pending Acceptance
- subscriptionNumber: SM-00005
status: Suspended
- subscriptionNumber: SM-00006
status: Active
invoiceNumbers:
- INV00000001
paymentNumber: P-00000002
paidAmount: 300
orderLineItems:
- id: bd78c0522adf42c2aa0fccacc997fa20
itemNumber: '116'
/v1/async-jobs/{jobId}:
get:
summary: Retrieve the status and response of a job
operationId: GET_JobStatusAndResponse
description: "**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nGet 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.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- in: path
name: jobId
description: UUID of the asynchronous job created by an asynchronous API operation.
required: true
type: string
format: UUID
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: OK
examples:
application/json:
status: Completed
errors: null
result:
success: true
orderNumber: OM-00002
accountNumber: A00000001
status: Pending
subscriptions:
- subscriptionNumber: SM-00001
status: Pending Activation
- subscriptionNumber: SM-00002
status: Pending Acceptance
- subscriptionNumber: SM-00003
status: Active
- subscriptionNumber: SM-00004
status: Pending Acceptance
invoiceNumbers:
- INV00000001
paymentNumber: P-00000002
paidAmount: 300
orderLineItems:
- id: bd78c0522adf42c2aa0fccacc997fa20
itemNumber: '116'
success: true
schema:
type: object
properties:
status:
type: string
description: Type of job status.
enum:
- Processing
- Failed
- Completed
errors:
type: string
description: Error messages returned if the job failed.
result:
$ref: '#/definitions/JobResult'
success:
type: boolean
description: Indicates whether the operation call succeeded.
/v1/orders/subscriptionOwner/{accountNumber}:
get:
summary: List orders of a subscription owner
operationId: GET_OrdersBySubscriptionOwner
description: "**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nRetrieves the detailed information about all orders for a specified subscription owner. Any orders containing the changes on the subscriptions owned by this account are returned.\n\n**Note**: You cannot retrieve detailed information about draft orders or scheduled orders through this operation.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: accountNumber
in: path
description: The subscription owner account number.
required: true
type: string
format: string
- $ref: '#/parameters/GLOBAL_REQUEST_page'
- $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
- name: dateFilterOption
in: query
description: 'The date type to filter on.
This field value can be ''orderDate'' or ''updatedDate''. Default is orderDate.
'
required: false
type: string
- name: startDate
in: query
description: 'The result will only contain the orders with the date of ''dateFilterOption'' later than or equal to this date.
'
required: false
type: string
format: date
- name: endDate
in: query
description: 'The result will only contain the orders with the date of ''dateFilterOption'' earlier than or equal to this date.
'
required: false
type: string
format: date
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/GetOrdersResponse'
examples:
application/json:
orders:
- orderNumber: O-00000002
orderDate: '2017-03-01'
createdDate: '2018-03-14 15:12:58'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
description: This is a description for the Order.
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: null
baseVersion: 1
newVersion: 2
orderActions:
- type: UpdateProduct
sequence: 0
triggerDates:
- triggerDate: '2017-03-01'
name: ContractEffective
- triggerDate: '2017-03-01'
name: ServiceActivation
- triggerDate: '2017-03-01'
name: CustomerAcceptance
updateProduct:
ratePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
specificUpdateDate: null
newRatePlanId: 2c989028622282520162235ada870649
chargeUpdates:
- description: null
chargeNumber: C-00000001
uniqueToken: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
quantity: 7
tiers: []
priceChangeOption: null
priceIncreasePercentage: null
effectiveDate:
specificTriggerDate: null
billing:
billingPeriodAlignment: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: null
customFields:
order_cf_date__c: '2017-01-01'
- orderNumber: O-00000001
orderDate: '2017-01-01'
createdDate: '2018-03-14 15:12:55'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: sub123
baseVersion: null
newVersion: 1
orderActions:
- type: CreateSubscription
sequence: 0
triggerDates:
- triggerDate: '2017-01-01'
name: ContractEffective
- triggerDate: '2017-01-01'
name: ServiceActivation
- triggerDate: '2017-01-01'
name: CustomerAcceptance
createSubscription:
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
renewalSetting: RENEW_WITH_SPECIFIC_TERM
initialTerm:
startDate: '2017-01-01'
period: 12
periodType: Month
termType: TERMED
renewalTerms:
- period: 0
periodType: Month
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- productRatePlanId: 2c989028622282520162235ac91605b3
newRatePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
chargeOverrides:
- description: null
chargeNumber: C-00000001
productRateplanChargeId: 2c989028622282520162235aca7a05b9
uniqueToken: null
pricing:
recurringVolume:
quantity: 12
tiers: []
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
startDate:
specificTriggerDate: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
billing:
billCycleDay: null
billingPeriod: null
billCycleType: null
billingTiming: null
billingPeriodAlignment: null
specificBillingPeriod: null
weeklyBillCycleDay: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: oa cf test
customFields:
order_cf_date__c: '2017-01-01'
success: true
/v1/orders/subscription/{subscriptionNumber}:
get:
summary: List orders by subscription number
operationId: GET_OrdersBySubscriptionNumber
description: "**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nRetrieves the detailed information about all orders for a specified subscription. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: subscriptionNumber
in: path
description: The subscription number.
required: true
type: string
- $ref: '#/parameters/GLOBAL_REQUEST_page'
- $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
- name: dateFilterOption
in: query
description: 'The date type to filter on. This field value can be ''orderDate'' or ''updatedDate''. Default is orderDate.
'
required: false
type: string
- name: startDate
in: query
description: 'The result will only contain the orders with the date of ''dateFilterOption'' later than or equal to this date.
'
required: false
type: string
format: date
- name: endDate
in: query
description: 'The result will only contain the orders with the date of ''dateFilterOption'' earlier than or equal to this date.
'
required: false
type: string
format: date
- name: status
in: query
description: The status of orders.
required: false
type: string
enum:
- all
- cancelled
- completed
- draft
- executing
- failed
- pending
- scheduled
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/GetOrdersResponse'
examples:
application/json:
orders:
- orderNumber: O-00000002
orderDate: '2017-03-01'
createdDate: '2018-03-14 15:12:58'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
description: This is a description for the Order.
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: null
baseVersion: 1
newVersion: 2
orderActions:
- type: UpdateProduct
sequence: 0
triggerDates:
- triggerDate: '2017-03-01'
name: ContractEffective
- triggerDate: '2017-03-01'
name: ServiceActivation
- triggerDate: '2017-03-01'
name: CustomerAcceptance
updateProduct:
ratePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
specificUpdateDate: null
newRatePlanId: 2c989028622282520162235ada870649
chargeUpdates:
- description: null
chargeNumber: C-00000001
uniqueToken: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
quantity: 7
tiers: []
priceChangeOption: null
priceIncreasePercentage: null
effectiveDate:
specificTriggerDate: null
billing:
billingPeriodAlignment: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: null
customFields:
order_cf_date__c: '2017-01-01'
- orderNumber: O-00000001
orderDate: '2017-01-01'
createdDate: '2018-03-14 15:12:55'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: sub123
baseVersion: null
newVersion: 1
orderActions:
- type: CreateSubscription
sequence: 0
triggerDates:
- triggerDate: '2017-01-01'
name: ContractEffective
- triggerDate: '2017-01-01'
name: ServiceActivation
- triggerDate: '2017-01-01'
name: CustomerAcceptance
createSubscription:
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
renewalSetting: RENEW_WITH_SPECIFIC_TERM
initialTerm:
startDate: '2017-01-01'
period: 12
periodType: Month
termType: TERMED
renewalTerms:
- period: 0
periodType: Month
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- productRatePlanId: 2c989028622282520162235ac91605b3
newRatePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
chargeOverrides:
- description: null
chargeNumber: C-00000001
productRateplanChargeId: 2c989028622282520162235aca7a05b9
uniqueToken: null
pricing:
recurringVolume:
quantity: 12
tiers: []
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
startDate:
specificTriggerDate: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
billing:
billCycleDay: null
billingPeriod: null
billCycleType: null
billingTiming: null
billingPeriodAlignment: null
specificBillingPeriod: null
weeklyBillCycleDay: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: oa cf test
customFields:
order_cf_date__c: '2017-01-01'
success: true
/v1/orders/invoiceOwner/{accountNumber}:
get:
summary: List orders of an invoice owner
operationId: GET_OrdersByInvoiceOwner
description: "**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nRetrieves the detailed information about all orders for a specified invoice owner. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: accountNumber
in: path
description: The invoice owner account number.
required: true
type: string
format: string
- $ref: '#/parameters/GLOBAL_REQUEST_page'
- $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
- name: dateFilterOption
in: query
description: 'The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.
'
required: false
type: string
- name: startDate
in: query
description: 'The result will only contain the orders with the date of dateFilterOption later than or equal to this date.
'
required: false
type: string
format: date
- name: endDate
in: query
description: 'The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date.
'
required: false
type: string
format: date
- name: status
in: query
description: The status of orders.
required: false
type: string
enum:
- all
- cancelled
- completed
- draft
- executing
- failed
- pending
- scheduled
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/GetOrdersResponse'
examples:
application/json:
orders:
- orderNumber: O-00000002
orderDate: '2017-03-01'
createdDate: '2018-03-14 15:12:58'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
description: This is a description for the Order.
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: null
baseVersion: 1
newVersion: 2
orderActions:
- type: UpdateProduct
sequence: 0
triggerDates:
- triggerDate: '2017-03-01'
name: ContractEffective
- triggerDate: '2017-03-01'
name: ServiceActivation
- triggerDate: '2017-03-01'
name: CustomerAcceptance
updateProduct:
ratePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
specificUpdateDate: null
newRatePlanId: 2c989028622282520162235ada870649
chargeUpdates:
- description: null
chargeNumber: C-00000001
uniqueToken: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
quantity: 7
tiers: []
priceChangeOption: null
priceIncreasePercentage: null
effectiveDate:
specificTriggerDate: null
billing:
billingPeriodAlignment: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: null
customFields:
order_cf_date__c: '2017-01-01'
- orderNumber: O-00000001
orderDate: '2017-01-01'
createdDate: '2018-03-14 15:12:55'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Completed
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: sub123
baseVersion: null
newVersion: 1
orderActions:
- type: CreateSubscription
sequence: 0
triggerDates:
- triggerDate: '2017-01-01'
name: ContractEffective
- triggerDate: '2017-01-01'
name: ServiceActivation
- triggerDate: '2017-01-01'
name: CustomerAcceptance
createSubscription:
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
renewalSetting: RENEW_WITH_SPECIFIC_TERM
initialTerm:
startDate: '2017-01-01'
period: 12
periodType: Month
termType: TERMED
renewalTerms:
- period: 0
periodType: Month
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- productRatePlanId: 2c989028622282520162235ac91605b3
newRatePlanId: 2c989028622282520162235acd1b05d2
uniqueToken: null
chargeOverrides:
- description: null
chargeNumber: C-00000001
productRateplanChargeId: 2c989028622282520162235aca7a05b9
uniqueToken: null
pricing:
recurringVolume:
quantity: 12
tiers: []
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
startDate:
specificTriggerDate: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
billing:
billCycleDay: null
billingPeriod: null
billCycleType: null
billingTiming: null
billingPeriodAlignment: null
specificBillingPeriod: null
weeklyBillCycleDay: null
customFields:
srpc_cf_picklist__c: null
customFields: {}
customFields:
oa_cf_text__c: oa cf test
customFields:
order_cf_date__c: '2017-01-01'
success: true
/v1/orders/{orderNumber}/customFields:
put:
tags:
- Orders
summary: Update order custom fields
description: '**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** To update the custom fields of an order line item, you must use the "Update an order line item" or "Update order line items" operation.
Updates the custom fields of a specified order.
'
operationId: PUT_UpdateOrderCustomFields
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: The order number.
required: true
type: string
format: string
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/PUTOrderPatchRequestType'
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/CommonResponseType'
examples:
application/json:
success: true
/v1/subscriptions/{subscriptionNumber}/customFields:
put:
tags:
- Orders
summary: Update subscription custom fields
description: '**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.
Updates the custom fields of a specified subscription.
'
operationId: PUT_UpdateSubscriptionCustomFields
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: subscriptionNumber
in: path
description: The subscription number to be updated.
required: true
type: string
format: string
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/PUTSubscriptionPatchRequestType'
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/CommonResponseType'
examples:
application/json:
success: true
/v1/orders/{orderNumber}/triggerDates:
put:
tags:
- Orders
summary: Update order action trigger dates
description: "**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.\n\nUpdates the triggering dates for either of the following order actions:\n * CreateSubscription\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
operationId: PUT_OrderTriggerDates
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: Order number of a pending order in which you are to update an order action's triggering dates.
required: true
type: string
format: string
- name: body
in: body
description: ''
required: true
schema:
$ref: '#/definitions/PUTOrderActionTriggerDatesRequestType'
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/PUTOrderTriggerDatesResponseType'
examples:
application/json:
success: true
orderNumber: OM-00002
accountNumber: A00000001
status: Pending
subscriptions:
- subscriptionNumber: SM-00001
status: Pending Activation
- subscriptionNumber: SM-00002
status: Pending Acceptance
- subscriptionNumber: SM-00003
status: Active
- subscriptionNumber: SM-00004
status: Pending Acceptance
/v1/orders/{orderNumber}/activate:
put:
tags:
- Orders
summary: Activate an order
description: '**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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.
Activate order is only available for draft orders.
'
operationId: PUT_OrderActivate
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: Order number of a order in which you are to activate.
required: true
type: string
format: string
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/PostOrderResponseType'
examples:
application/json:
success: true
orderNumber: OM-00002
accountNumber: A00000001
status: Pending
subscriptions:
- subscriptionNumber: SM-00001
status: Pending Activation
- subscriptionNumber: SM-00002
status: Pending Acceptance
- subscriptionNumber: SM-00003
status: Active
- subscriptionNumber: SM-00004
status: Pending Acceptance
- subscriptionNumber: SM-00005
status: Suspended
- subscriptionNumber: SM-00006
status: Active
invoiceNumbers:
- INV00000001
paymentNumber: P-00000002
paidAmount: 300
orderLineItems:
- id: bd78c0522adf42c2aa0fccacc997fa20
itemNumber: '116'
/v1/orders/{orderNumber}/cancel:
put:
tags:
- Orders
summary: Cancel an order
description: '**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#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:** Cancellation is only valid for draft or scheduled orders. If the order is not in draft or scheduled status, the API returns an error.
The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.
'
operationId: PUT_OrderCancel
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: orderNumber
in: path
description: The order number of the draft order you wish to cancel.
required: true
type: string
format: string
- name: body
in: body
description: ''
required: false
schema:
type: object
properties:
cancelReason:
type: string
description: The reason for cancelling the order.
example: Customer cancelled the order.
responses:
200:
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
description: ''
schema:
$ref: '#/definitions/PutOrderCancelResponse'
examples:
application/json:
success: true
orderNumber: OM-00002
accountNumber: A00000001
status: Cancelled
CancelReason: Customer cancelled the order.
/v1/orders/subscription/{subscription-key}/pending:
get:
summary: List pending orders by subscription number
operationId: GET_PendingOrdersBySubscriptionNumber
description: "**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n\nRetrieves the detailed information about all pending orders for a specified subscription.\n"
tags:
- Orders
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: subscription-key
in: path
description: 'Subscription number. For example, A-S00000135.
'
required: true
type: string
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
orders:
- orderNumber: O-00000001
orderDate: '2017-01-01'
createdDate: '2018-03-14 15:12:55'
createdBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
updatedBy: 2c989028622282520162235ab0f603ba
existingAccountNumber: accountA_Num
currency: USD
status: Pending
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
subscriptions:
- subscriptionNumber: A-S00000001
customFields:
sub_cf_picklist__c: sub123
baseVersion: null
newVersion: 1
orderActions:
- type: CreateSubscription
sequence: 0
triggerDates:
- triggerDate: '2017-01-01'
name: ContractEffective
- triggerDate: '2017-01-01'
name: ServiceActivation
createSubscription:
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
renewalSetting: RENEW_WITH_SPECIFIC_TERM
initialTerm:
startDate: '2017-01-01'
period: 12
periodType: Month
termType: TERMED
renewalTerms:
- period: 0
periodType: Month
subscribeToRatePlans:
- productRatePlanId: 2c989028622282520162235ac91605b3
newRatePlanId: 2c989028622282520162235acd1b05d2
chargeOverrides:
- chargeNumber: C-00000001
productRateplanChargeId: 2c989028622282520162235aca7a05b9
pricing:
recurringVolume:
quantity: 12
tiers: []
listPriceBase: Per_Billing_Period
customFields: {}
customFields:
order_cf_date__c: '2017-01-01'
success: true
description: ''
schema:
$ref: '#/definitions/GetAllOrdersResponseType'
definitions:
RampIntervalResponse:
properties:
description:
description: The short description of the interval.
type: string
endDate:
description: The end date of the interval.
format: date
type: string
name:
description: The name of the interval.
type: string
startDate:
description: The start date of the interval.
format: date
type: string
title: intervals
type: object
OrderDeltaMetric:
properties:
chargeNumber:
description: 'The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.
'
type: string
currency:
description: 'ISO 3-letter currency code (uppercase). For example, USD.
'
type: string
endDate:
description: 'The end date for the order delta metric.
'
format: date
type: string
grossAmount:
description: 'The gross amount for the metric. The is the amount excluding applied discount.
'
type: number
netAmount:
description: 'The net amount for the metric. The is the amount with discounts applied
'
type: number
orderActionId:
description: 'The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.
'
type: string
orderActionSequence:
description: 'The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.
'
type: string
orderActionType:
description: 'The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.
'
type: string
orderLineItemNumber:
description: 'A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1".
'
type: string
productRatePlanChargeId:
description: '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.
'
type: string
ratePlanChargeId:
description: 'The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.
'
type: string
startDate:
description: 'The start date for the order delta metric.
'
format: date
type: string
subscriptionNumber:
description: 'The number of the subscription. This field can be null if the metric is generated for an Order Line Item.
'
type: string
type: object
Account:
allOf:
- description: 'The information of the new account to be created with the order. Note that this actually specifies the invoice owner account of the subscriptions included in this order. To create the new account, either a **creditCard** structure or the **hpmCreditCardPaymentMethodId** field (but not both) should be provided. The one provided becomes the default payment method for this account. If the credit card information is declined or can''t be verified, then the account is not created.
'
properties:
accountNumber:
maxLength: 70
type: string
additionalEmailAddresses:
description: 'List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.
'
maxLength: 1200
type: string
allowInvoiceEdit:
description: "Indicates if associated invoices can be edited.\nValues are: \n\n* `true`\n* `false` (default)\n"
type: boolean
autoPay:
description: Specifies whether future payments are to be automatically billed when they are due. Possible values are `true`, `false`.
type: boolean
batch:
description: '**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
'
type: string
billCycleDay:
description: Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
maximum: 31
minimum: 0
type: integer
billToContact:
$ref: '#/definitions/BillToContactPostOrder'
communicationProfileId:
type: string
creditCard:
$ref: '#/definitions/creditCard'
creditMemoTemplateId:
description: '**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
'
type: string
crmId:
maxLength: 100
type: string
currency:
description: '3 uppercase character currency code.
For payment method authorization, if the `paymentMethod` > `currencyCode` field is specified, `currencyCode` is used. Otherwise, this `currency` field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
'
type: string
customFields:
$ref: '#/definitions/AccountObjectCustomFields'
customerServiceRepName:
description: 'Name of the account''s customer service representative, if applicable.
'
maxLength: 50
type: string
debitMemoTemplateId:
description: '**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
'
type: string
hpmCreditCardPaymentMethodId:
description: 'The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.
If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,
but not both.
For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.
'
type: string
invoiceDeliveryPrefsEmail:
description: "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account.\n"
type: boolean
invoiceDeliveryPrefsPrint:
description: "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
type: boolean
invoiceTemplateId:
type: string
name:
maxLength: 255
type: string
notes:
maxLength: 65535
type: string
organizationLabel:
description: "Name of the organization that the account belongs to. \n\nThis field is only required when you have already turned on Multi-Org feature. \n"
type: string
parentId:
description: Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled.
type: string
partnerAccount:
default: false
description: "Whether the customer account is a partner, distributor, or reseller. \n\n\nYou can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.\n\n\n**Note**: This field is available only if you have the Reseller Account feature enabled.\n"
type: boolean
paymentGateway:
maxLength: 40
type: string
paymentMethod:
$ref: '#/definitions/PostOrderAccountPaymentMethod'
paymentTerm:
description: '**Note**: If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use `Due Upon Receipt` as the value instead of the default value set in **Billing Settings** > **Payment Terms** from Zuora UI.
'
type: string
purchaseOrderNumber:
description: 'The number of the purchase order associated with this account. Purchase order information generally comes from customers.
'
maxLength: 100
type: string
salesRep:
description: 'The name of the sales representative associated with this account, if applicable.
'
maxLength: 50
type: string
sequenceSetId:
description: "The ID of the sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n"
type: string
soldToContact:
$ref: '#/definitions/SoldToContactPostOrder'
soldToSameAsBillTo:
description: "Whether the sold-to contact and bill-to contact are the same entity. \n\nThe created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:\n\n- This field is set to `true`. \n- A bill-to contact is specified.\n- No sold-to contact is specified.\n"
type: boolean
taxInfo:
$ref: '#/definitions/TaxInfo'
required:
- name
- currency
- billCycleDay
- billToContact
type: object
- $ref: '#/definitions/DataAccessControlField'
ChangePlanChargeOverride:
description: 'Charge associated with a rate plan.
'
properties:
accountReceivableAccountingCode:
description: 'The accountReceivableAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.
'
type: string
adjustmentLiabilityAccountingCode:
description: 'The adjustmentLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
adjustmentRevenueAccountingCode:
description: 'The adjustmentRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
billing:
description: 'Billing information about the charge.
'
properties:
billCycleDay:
description: 'Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.
'
maximum: 31
minimum: 0
type: integer
billCycleType:
description: "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
enum:
- DefaultFromCustomer
- SpecificDayofMonth
- SubscriptionStartDay
- ChargeTriggerDay
- SpecificDayofWeek
type: string
billingPeriod:
description: 'Billing frequency of the charge. The value of this field controls the duration of each billing period.
If the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.
'
enum:
- Month
- Quarter
- Semi_Annual
- Annual
- Eighteen_Months
- Two_Years
- Three_Years
- Five_Years
- Specific_Months
- Subscription_Term
- Week
- Specific_Weeks
- Specific_Days
type: string
billingPeriodAlignment:
description: 'Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.
* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.
* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.
* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.
See the `billCycleType` field for information about how Zuora determines the billing day.
'
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
billingTiming:
description: 'Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).
'
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
specificBillingPeriod:
description: 'Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.
'
type: integer
weeklyBillCycleDay:
description: 'Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.
'
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
type: object
chargeModel:
description: 'The chargeModel of a standalone charge.
Supported charge models:
* `FlatFee`
* `PerUnit`
* `Volume`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
chargeNumber:
description: 'Charge number of the charge. For example, C-00000307.
If you do not set this field, Zuora will generate the charge number.
'
maxLength: 50
type: string
chargeType:
description: 'The chargeType of a standalone charge.
Supported charge types:
* `OneTime`
* `Recurring`
* `Usage`
* `DiscountFixedAmount`
* `DiscountPercentage`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
contractAssetAccountingCode:
description: 'The contractAssetAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractLiabilityAccountingCode:
description: 'The contractLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractRecognizedRevenueAccountingCode:
description: 'The contractRecognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
deferredRevenueAccountingCode:
description: 'The deferredRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
description:
description: 'Description of the charge.
'
maxLength: 500
type: string
drawdownRate:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).
'
type: number
endDate:
$ref: '#/definitions/EndConditions'
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charges from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isRollover:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The value is either "True" or "False". It determines whether the rollover fields are needed.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
name:
description: 'The name of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
pobPolicy:
description: 'The pobPolicy of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
prepaidQuantity:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).
'
type: number
pricing:
description: 'Pricing information about the charge.
'
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingOverride'
oneTimeFlatFee:
$ref: '#/definitions/OneTimeFlatFeePricingOverride'
oneTimePerUnit:
$ref: '#/definitions/OneTimePerUnitPricingOverride'
oneTimeTiered:
$ref: '#/definitions/OneTimeTieredPricingOverride'
oneTimeVolume:
$ref: '#/definitions/OneTimeVolumePricingOverride'
recurringDeliveryBased:
$ref: '#/definitions/RecurringDeliveryPricingOverride'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingOverride'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingOverride'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingOverride'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingOverride'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingOverride'
usageOverage:
$ref: '#/definitions/UsageOveragePricingOverride'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingOverride'
usageTiered:
$ref: '#/definitions/UsageTieredPricingOverride'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingOverride'
usageVolume:
$ref: '#/definitions/UsageVolumePricingOverride'
type: object
productCategory:
description: 'The productCategory of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productClass:
description: 'The productClass of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productFamily:
description: 'The productFamily of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productLine:
description: 'The productLine of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productRatePlanChargeId:
description: 'Internal identifier of the product rate plan charge that the charge is based on.
'
type: string
productRatePlanChargeNumber:
description: 'Number of a product rate-plan charge for this subscription.
'
type: string
recognizedRevenueAccountingCode:
description: 'The recognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
revRecCode:
description: 'Revenue Recognition Code
'
maxLength: 70
type: string
revRecTriggerCondition:
description: "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
enum:
- Contract Effective Date
- Service Activation Date
- Customer Acceptance Date
type: string
revenueRecognitionRuleName:
description: 'Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.
'
type: string
rolloverApply:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the priority of rollover, which is either first or last.
'
enum:
- ApplyFirst
- ApplyLast
type: string
rolloverPeriodLength:
default: null
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period length of the rollover fund.
'
type: integer
rolloverPeriods:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the number of rollover periods, it is restricted to 3.
'
type: number
startDate:
$ref: '#/definitions/CreateOrderTriggerParams'
taxCode:
description: 'The taxCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
taxMode:
description: "The taxMode of a standalone charge. \n\nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"
type: string
unBilledReceivablesAccountingCode:
description: 'The unBilledReceivablesAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
uniqueToken:
description: 'Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
'
maxLength: 50
type: string
validityPeriodType:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
'
enum:
- SUBSCRIPTION_TERM
- ANNUAL
- SEMI_ANNUAL
- QUARTER
- MONTH
type: string
required:
- productRatePlanChargeId
title: charge
type: object
PriceChangeParams:
properties:
priceChangeOption:
description: 'Specifies how Zuora changes the price of the charge each time the subscription renews.
If the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.
'
enum:
- NoChange
- SpecificPercentageValue
- UseLatestProductCatalogPricing
type: string
priceIncreasePercentage:
description: 'Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.
'
minimum: -100
type: number
type: object
AccountObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Account object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of an Account object.
'
title: accountFieldsCustom
type: object
RecurringDeliveryPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
deliverySchedule:
$ref: '#/definitions/DeliveryScheduleParams'
listPrice:
type: number
type: object
OrderItem:
description: "Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of products or a service, but defined by both quantity and term (the start and end dates). \n\nFor the one time and the recurring charge types, if an order action causes a quantity metric creation (when the delta quantity equals to or is greater than zero), an order item is created.\n\nThe following order actions will create an order item for the one time and recurring charges. The other order actions will refer to an existing order item. Also, the Owner Transfer order action always creates an order item whose quantity field is zero.\n\n * Create Subscription\n * Terms and Conditions - Extend Term\n * Renewal\n * Update Product - Increase Quantity\n * Add product\n * Owner Transfer\n\nFor the usage charge type, if the order action causes a usage increase, an order item is created, and the quantity field of the order item is always zero.\n\nThe following order actions will create an order item for for the usage charges.\n\n * Create Subscription\n * Terms and Conditions - Extend Term\n * Renewal\n * Add product\n * Owner Transfer\n"
properties:
endDate:
description: The order item's effective end date, aligned with the end date of an increased quantity order metrics.
format: date
type: string
id:
description: The ID of the order item.
type: string
orderActionId:
description: Specify the order action that creates this order item.
type: string
quantity:
description: 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.
type: number
scId:
description: The ID of the charge segment that gets newly generated when the order item is created.
type: string
startDate:
description: The order item's effective start date, aligned with the start date of an increased quantity order metrics.
format: date
type: string
type: object
PriceIntervalWithPrice:
properties:
duration:
description: 'Duration period of this interval.
'
minimum: 1
type: integer
price:
description: 'Price of this interval.
'
type: number
sequence:
description: 'Index of the interval in the interval pricing.
'
minimum: 1
type: integer
type:
description: 'Interval type of this pricing.
'
enum:
- Day
- Month
- Infinity
type: string
title: priceIntervalWithPrice
type: object
GetOfferRatePlanUpdate:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
chargeUpdates:
items:
$ref: '#/definitions/ChargeUpdate'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
newRatePlanId:
description: 'Internal identifier of the updated rate plan in the new subscription version.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'Internal identifier of the rate plan that was updated. It can be the latest version or any history version id.
'
type: string
specificUpdateDate:
description: '
The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.
See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
'
format: date
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/RatePlanFeatureOverride'
type: array
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
uniqueToken:
description: 'A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
'
type: string
title: updateProduct
type: object
PUTSubscriptionPatchRequestType:
example:
customFields:
sub_cf__c: subscription custom field
ratePlans:
- charges:
- chargeNumber: C-00000016
customFields:
sub_rpc__c: rate plan charge custom field
customFields:
sub_rate_plan__c: rate plan custom field
ratePlanId: 8a8081085d834928015da220da08207f
properties:
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
ratePlans:
items:
properties:
charges:
items:
properties:
chargeId:
description: 'Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See Segmented rate plan charges for more information about charge segments.
'
type: string
chargeNumber:
description: 'Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See Segmented rate plan charges for more information about charge segments.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
type: object
type: array
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
ratePlanId:
description: The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version.
type: string
type: object
type: array
type: object
TriggerDate:
properties:
name:
description: 'Name of the trigger date of the order action.
'
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
type: string
triggerDate:
description: 'Trigger date in YYYY-MM-DD format.
'
format: date
type: string
title: triggerDate
type: object
CreatePMPayPalECPayPalNativeECPayPalCP:
properties:
BAID:
description: 'ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.
'
type: string
email:
description: "Email address associated with the payment method. This field is supported for the following payment methods:\n - PayPal payment methods. This field is required for creating any of the following PayPal payment methods.\n - PayPal Express Checkout\n - PayPal Adaptive\n - PayPal Commerce Platform\n - Apple Pay and Google Pay payment methods on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.\n"
type: string
type: object
PostOrderResponseType:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
accountId:
description: The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`.
maxLength: 32
type: string
accountNumber:
description: The account number for the order.
maxLength: 50
type: string
creditMemoIds:
description: 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`.
items:
type: string
maxLength: 32
type: array
creditMemoNumbers:
description: 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.
items:
type: string
maxLength: 255
type: array
invoiceIds:
description: 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`.
items:
type: string
maxLength: 32
type: array
invoiceNumbers:
description: 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.
items:
type: string
maxLength: 255
type: array
orderId:
description: The ID of the order created. This field is returned instead of the `orderNumber` field if the `returnIds` query parameter is set to `true`.
maxLength: 32
type: string
orderLineItems:
items:
properties:
id:
description: The sytem generated Id for the Order Line Item.
format: UUID
maxLength: 32
type: string
itemNumber:
description: The number for the Order Line Item.
format: UUID
maxLength: 100
type: string
type: object
type: array
orderNumber:
description: The order number of the order created.
maxLength: 100
type: string
paidAmount:
description: The total amount collected in this order request.
maxLength: 22
minLength: 9
type: string
paymentId:
description: 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`.
maxLength: 32
type: string
paymentNumber:
description: The payment number that is collected in this order request.
maxLength: 32
type: string
ramps:
description: '**Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_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://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
The ramp definitions created by this order request.
'
items:
properties:
rampNumber:
description: The number of the ramp definition.
maxLength: 50
type: string
subscriptionNumber:
description: The number of the subscription that this ramp deal definition is applied to.
maxLength: 150
type: string
type: object
type: array
refunds:
items:
properties:
number:
description: The refund number. For example, `R-00009564`.
maxLength: 32
type: string
refundInvoiceNumbers:
description: An array of the refunded invoice numbers generated in this order request.
items:
type: string
maxLength: 255
type: array
status:
description: The status of the refund.
enum:
- Success
- Error
type: string
type: object
type: array
status:
description: Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action.
enum:
- Draft
- Pending
- Completed
type: string
subscriptionIds:
description: Container for the subscription IDs of the subscriptions in an order. This field is returned if the `returnIds` query parameter is set to `true`.
items:
type: string
maxLength: 32
type: array
subscriptionNumbers:
description: Container for the subscription numbers of the subscriptions in an order. Subscriptions in the response are displayed in the same sequence as the subscriptions defined in the request.
items:
type: string
maxLength: 150
type: array
subscriptions:
description: '**Note:** This field is in Zuora REST API version control. Supported minor versions are 223.0 or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-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.
'
items:
properties:
status:
description: Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action.
enum:
- Active
- Pending Activation
- Pending Acceptance
- Cancelled
- Suspended
type: string
subscriptionId:
description: 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`.
maxLength: 32
type: string
subscriptionNumber:
description: Subscription number of the subscription included in this order.
maxLength: 150
type: string
type: object
type: array
writeOff:
items:
properties:
amount:
description: The amount written off from the invoice balance.
maximum: 22
minimum: 9
type: number
failedReason:
description: The reason of write-off failure.
type: string
invoiceNumber:
description: The number of the invoice that is written off. For example, `INV00051208`.
maxLength: 255
type: string
status:
description: The status of the write-off.
enum:
- Success
- Failed
type: string
writeOffCreditMemoNumber:
description: The number of the credit memo that is written off.
maxLength: 255
type: string
type: object
type: array
type: object
RecurringTieredPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPriceBase:
description: 'Specifies the duration of each recurring period.
'
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
priceIntervals:
description: "List of tier prices with intervals. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer.\n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
items:
$ref: '#/definitions/PriceIntervalWithTiers'
type: array
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
specificListPriceBase:
description: "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the Annual List Price feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
format: int32
maximum: 200
minimum: 1
type: integer
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
description: 'Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.
'
title: recurringTiered
OrderRampMetrics:
properties:
description:
description: The short description of the ramp.
type: string
discountTcb:
description: The discount amount for the TCB.
type: number
discountTcv:
description: The discount amount for the TCV.
type: number
grossTcb:
description: The gross TCB value before discount charges are applied.
type: number
grossTcv:
description: The gross TCV value before discount charges are applied.
type: number
intervals:
description: The ramp metrics for each ramp intervals in its timeline.
items:
$ref: '#/definitions/OrderRampIntervalMetrics'
type: array
name:
description: The name of the ramp.
type: string
netTcb:
description: The net TCB value after discount charges are applied.
type: number
netTcv:
description: The net TCV value after discount charges are applied.
type: number
number:
description: The number of the ramp. It is automaticcally generated by the billing system.
type: string
title: RampMetrics
type: object
PUTOrderPatchRequestType:
example:
customFields:
order_cf__c: order custom fields
subscriptions:
- orderActions:
- customFields:
order_action_cf__c: Order action custom fields
order_action_undex__c: Order action custom fields
sequence: 0
subscriptionNumber: S-00005
properties:
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
subscriptions:
items:
properties:
orderActions:
items:
properties:
customFields:
$ref: '#/definitions/OrderActionObjectCustomFields'
orderActionId:
description: 'The Id of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.
'
type: string
sequence:
description: 'The sequence number of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.
'
type: integer
type: object
type: array
subscriptionNumber:
type: string
type: object
type: array
type: object
LastTerm:
description: The length of the period for the current subscription term.
properties:
period:
description: Specify only when the termType is 'TERMED'.
minimum: 0
type: integer
periodType:
description: Specify only when the termType is 'TERMED'.
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'The start date of the current term. You can change the term start date of a renewed subscription through a T&Cs order action. However, when changing it to an earlier date, this date must not be earlier than the term start date of the current term before this T&Cs.
'
format: date
type: string
termType:
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
DiscountPricingUpdate:
properties:
applyDiscountTo:
description: 'Specifies which type of charge the discount charge applies to.
'
enum:
- ONETIME
- RECURRING
- USAGE
- ONETIMERECURRING
- ONETIMEUSAGE
- RECURRINGUSAGE
- ONETIMERECURRINGUSAGE
type: string
discountLevel:
description: 'Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.
'
enum:
- rateplan
- subscription
- account
type: string
discountPercentage:
description: 'The amount of the discount as a percentage. This field is only used for percentage discounts.
'
type: number
priceChangeOption:
description: 'Specifies how Zuora changes the price of the charge each time the subscription renews.
'
enum:
- NoChange
- UseLatestProductCatalogPricing
type: string
type: object
RecurringDeliveryPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
deliverySchedule:
$ref: '#/definitions/DeliveryScheduleParams'
listPrice:
description: 'Price of the charge in each recurring period.
'
type: number
priceIntervals:
description: "List of interval pricing in the charge. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer.\n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
items:
$ref: '#/definitions/PriceIntervalWithPrice'
type: array
type: object
description: 'Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.
**Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**.
'
title: recurringDelivery
BillToContact:
allOf:
- description: 'Contact details associated with an account.
'
properties:
address1:
description: 'First line of the contact''s address. This is often a street address or a business name.
'
maxLength: 255
type: string
address2:
description: 'Second line of the contact''s address.
'
maxLength: 255
type: string
city:
description: 'City of the contact''s address.
'
maxLength: 40
type: string
country:
description: 'Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax.
'
maxLength: 64
type: string
county:
description: 'County of the contact''s address.
'
maxLength: 32
type: string
fax:
description: 'Fax number of the contact.
'
maxLength: 40
type: string
firstName:
description: 'First name of the contact.
'
maxLength: 100
type: string
homePhone:
description: 'Home phone number of the contact.
'
maxLength: 40
type: string
lastName:
description: 'Last name of the contact.
'
maxLength: 100
type: string
mobilePhone:
description: 'Mobile phone number of the contact.
'
maxLength: 40
type: string
nickname:
description: 'Nickname of the contact.
'
maxLength: 100
type: string
otherPhone:
description: 'Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.
'
maxLength: 40
type: string
otherPhoneType:
description: 'Specifies the type of phone number in the `otherPhone` field.
'
enum:
- Work
- Mobile
- Home
- Other
type: string
personalEmail:
description: 'Personal email address of the contact.
'
format: email
maxLength: 80
type: string
postalCode:
description: 'ZIP code or other postal code of the contact''s address.
'
maxLength: 20
type: string
state:
description: 'State or province of the contact''s address.
'
maxLength: 40
type: string
taxRegion:
description: 'Region defined in your taxation rules. Only applicable if you use Zuora Tax.
'
maxLength: 32
type: string
workEmail:
description: 'Business email address of the contact.
'
format: email
maxLength: 80
type: string
workPhone:
description: 'Business phone number of the contact.
'
maxLength: 40
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
CreatePaymentMethodBankTransfer:
properties:
IBAN:
description: "The International Bank Account Number. \n\nThis field is required if the `type` field is set to `SEPA`. However, for creating tokenized SEPA payment methods on Adyen Integration v2.0, this field is optional. \n - If the `tokenize` field is `true`, `IBAN` is required. \n - If the `tokens` field is specified, `IBAN` is not required but `accountMaskNumber` is required.\n"
type: string
accountHolderInfo:
description: "This container field is required for the following bank transfer payment methods. The nested `accountHolderName` field is required.\n - Direct Debit NZ (`Becsnz`)\n - Single Euro Payments Area (`SEPA`)\n - Direct Debit UK (`Bacs`)\n - Denmark Direct Debit (`Betalingsservice`)\n - Sweden Direct Debit (`Autogiro`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
properties:
accountHolderName:
description: 'Required.
The full name of the bank account holder.
'
maxLength: 60
type: string
addressLine1:
description: 'The first line of the address for the account holder.
This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
'
type: string
addressLine2:
description: "The second line of the address for the account holder. \n"
type: string
city:
description: 'The city where the account holder stays.
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
'
type: string
country:
description: 'The country where the account holder stays.
This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
'
type: string
email:
description: 'The email address of the account holder.
'
type: string
firstName:
description: 'The first name of the account holder.
'
type: string
lastName:
description: 'The last name of the account holder.
'
type: string
phone:
description: 'The phone number of the account holder.
'
type: string
state:
description: 'The state where the account holder stays.
'
type: string
zipCode:
description: 'The zip code for the address of the account holder.
'
type: string
type: object
accountMaskNumber:
description: "The masked account number such as ****1234.\n\nWhen creating the following tokenized payment methods, if the `tokens` field is provided, this `accountMaskNumber` field is required.\n - SEPA payment methods on Adyen\n - BACS payment methods on Stripe\n\nFor more information about how to create the preceding tokenized payment methods, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
type: string
accountNumber:
description: "The number of the customer's bank account. This field is required for the following bank transfer payment methods:\n - Direct Entry AU (`Becs`)\n - Direct Debit NZ (`Becsnz`)\n - Direct Debit UK (`Bacs`). For creating tokenized BACS payment methods on Stripe v2, this field is optional. If the `tokens` field is specified, `accountNumber` is not required but `accountMaskNumber` is required.\n - Denmark Direct Debit (`Betalingsservice`)\n - Sweden Direct Debit (`Autogiro`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
type: string
bankCode:
description: "The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:\n - Direct Debit UK (`Bacs`)\n - Denmark Direct Debit (`Betalingsservice`)\n - Direct Debit NZ (`Becsnz`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
type: string
branchCode:
description: "The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:\n - Sweden Direct Debit (`Autogiro`)\n - Direct Entry AU (`Becs`)\n - Direct Debit NZ (`Becsnz`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
type: string
businessIdentificationCode:
description: 'The BIC code used for SEPA.
'
type: string
currencyCode:
description: 'The currency used for payment method authorization.
If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
'
type: string
identityNumber:
description: "The identity number used for Bank Transfer. This field is required for the following bank transfer payment methods:\n - Denmark Direct Debit (`Betalingsservice`)\n - Sweden Direct Debit (`Autogiro`)\n"
type: string
tokenize:
default: false
description: "When creating a SEPA payment method on Adyen Integration v2.0, use this field to specify whether to tokenize the payment method with IBAN. If `tokenize` is `true`, `IBAN` is required.\n\nIf the `tokens` field is provided, this `tokenize` field is not required. \n\nFor more information about how to create tokenized SEPA payment methods on Adyen, see Tokenize SEPA payment methods on Adyen Integration v2.0.\n"
type: boolean
tokens:
description: "To create the following tokenized payment methods, pass in the existing token information:\n - Tokenized SEPA payment methods on Adyen Integration v2.0\n - Tokenized BACS payment methods on Stripe v2\n\nFor more information about how to create the preceding tokenized payment methods, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
properties:
gatewayType:
description: "Required. \n\nThe type of the payment gateway to generate the tokens. This field is case-sensitive.\n"
enum:
- Adyen
- Stripe
type: string
secondTokenId:
description: "Pass in the second token of the payment method. The value of this field varies depending on gateways. For more information, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
type: string
thirdTokenId:
description: 'Pass in the third token of the payment method.
'
type: string
tokenId:
description: "Required. \n\nPass in the first token of the payment method. The value of this field varies depending on gateways. For more information, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
type: string
type: object
type: object
creditCard:
description: 'Default payment method associated with an account. Only credit card payment methods are supported.
'
properties:
cardHolderInfo:
$ref: '#/definitions/AccountCreditCardHolder'
cardNumber:
description: 'Card number. Once set, you cannot update or query the value of this field. The value of this field is only available in masked format. For example, XXXX-XXXX-XXXX-1234 (hyphens must not be used when you set the credit card number).
'
type: string
cardType:
description: 'Type of card.
'
enum:
- Visa
- MasterCard
- AmericanExpress
- Discover
- JCB
- Diners
- CUP
- Maestro
- Electron
- AppleVisa
- AppleMasterCard
- AppleAmericanExpress
- AppleDiscover
- AppleJCB
- Elo
- Hipercard
- Naranja
- Nativa
- TarjetaShopping
- Cencosud
- Argencard
- Cabal
type: string
expirationMonth:
description: 'Expiration date of the card.
'
maximum: 12
minimum: 1
type: integer
expirationYear:
description: 'Expiration year of the card.
'
maximum: 2500
minimum: 1980
type: integer
securityCode:
description: 'CVV or CVV2 security code of the card. To ensure PCI compliance, Zuora does not store the value of this field.
'
type: string
type: object
UsageTieredPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
ratingGroup:
description: "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
type: string
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
type: object
description: 'Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.
'
title: usageTiered
processingOptionsOrders:
description: 'The container for billing processing options and payment processing options.
**Note:**
- This field is not supported in draft orders.
- When you use the "Create an order" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created.
- When you use the "Create an order" operation to cancel a subscription with `refund` and `writeOff`, if the `refund` or `writeOff` fails, `cancelSubscription`, `runBilling`, and `collectPayment` still can succeed.
- When you use the "Create an order" operation, the `collectPayment` and `refund` fields cannot be set to `true` simultaneously. Otherwise, the order will not be proceeded.
'
properties:
applicationOrder:
description: "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
items:
type: string
type: array
applyCredit:
description: "Whether to automatically apply credit memos or unapplied payments, or both to an invoice.\n\nIf the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. \n\n\n**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
type: boolean
applyCreditBalance:
description: 'Indicates if any credit balance on a customer''s account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.
'
type: boolean
billingOptions:
properties:
creditMemoReasonCode:
description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.
type: string
documentDate:
description: 'The invoice date displayed on the invoice.
'
format: date
type: string
generateDraftInvoice:
description: 'Indicates if the current request needs to generate a draft invoice.
Values are:
* `true`
* `false` (default)
'
type: boolean
targetDate:
description: 'Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).
'
format: date
type: string
type: object
collectPayment:
description: 'Indicates if the current request needs to collect payments. This value can not be ''true'' when ''runBilling'' flag is ''false''.
'
type: boolean
electronicPaymentOptions:
description: 'Container for the electronic payment options.
'
properties:
paymentGatewayId:
description: 'Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.
'
type: string
paymentMethodId:
description: 'Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.
'
type: string
type: object
refund:
description: "Indicates whether to refund after subscription cancelation. Default is `false`. \n\n**Note**: When refunding a subscription that is not invoiced separately, if you do not enable the Invoice Item Settlement feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n"
type: boolean
refundAmount:
description: 'Indicates the amount to be refunded. Required if the `refund` field is `true`.
'
type: number
refundReasonCode:
description: 'A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.
'
type: string
runBilling:
description: 'Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.
'
type: boolean
writeOff:
description: "Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`.\n\n**Note**: \n- When refunding a subscription that is not invoiced separately, if you do not enable the Invoice Item Settlement feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n- The Invoice Settlement feature must have been enabled for write-off.\n"
type: boolean
writeOffBehavior:
description: "The financial information of the credit memo items generated to write off the invoice balance. \n\n**Note:** \n - All the credit memo items that are used to write off the invoice will be applied with the same financial information.\n - Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.\n"
properties:
financeInformation:
description: 'Container for the finance information related to the credit memo items that are created for invoice write-off.
'
properties:
deferredRevenueAccountingCode:
description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.
'
maxLength: 100
minLength: 0
type: string
onAccountAccountingCode:
description: 'The accounting code that maps to an on account in your accounting system.
'
maxLength: 100
minLength: 0
type: string
recognizedRevenueAccountingCode:
description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.
'
maxLength: 100
minLength: 0
type: string
revenueRecognitionRuleName:
description: 'The name of the revenue recognition rule governing the revenue schedule.
'
maxLength: 100
minLength: 0
type: string
type: object
type: object
type: object
TimeSlicedMetrics:
properties:
amount:
type: number
endDate:
format: date
type: string
generatedReason:
description: "Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
enum:
- IncreaseQuantity
- DecreaseQuantity
- ChangePrice
- Extension
- Contraction
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the subscription.
type: string
orderItemId:
description: "The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
type: string
startDate:
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
termNumber:
format: long
type: number
type: object
CreateSubscription:
description: 'Information about an order action of type `CreateSubscription`.
'
properties:
billToContactId:
description: "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
currency:
description: "The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.\n\nAll subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.\n\n**Note**: This field is available only if you have the Multiple Currencies feature enabled. \n"
maxLength: 3
type: string
invoiceSeparately:
description: 'Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.
'
type: boolean
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
newSubscriptionOwnerAccount:
description: 'Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.
**Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
If you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.
'
properties:
accountNumber:
description: 'Account number. For example, A00000001.
'
maxLength: 70
type: string
autoPay:
description: 'Specifies whether future payments are automatically billed when they are due.
'
type: boolean
batch:
description: 'Name of the billing batch that the account belongs to. For example, Batch1.
'
type: string
billCycleDay:
description: 'Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
'
maximum: 31
minimum: 0
type: integer
billToContact:
$ref: '#/definitions/BillToContact'
communicationProfileId:
description: 'Internal identifier of the communication profile that Zuora uses when sending notifications to the account''s contacts.
'
type: string
creditCard:
$ref: '#/definitions/creditCard'
crmId:
description: 'External identifier of the account in a CRM system.
'
maxLength: 100
type: string
currency:
description: 'ISO 3-letter currency code (uppercase). For example, USD.
'
type: string
customFields:
$ref: '#/definitions/AccountObjectCustomFields'
hpmCreditCardPaymentMethodId:
description: 'The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.
If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,
but not both.
For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.
'
type: string
invoiceDeliveryPrefsEmail:
description: "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account. \n"
type: boolean
invoiceDeliveryPrefsPrint:
description: "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
type: boolean
invoiceTemplateId:
description: 'Internal identifier of the invoice template that Zuora uses when generating invoices for the account.
'
type: string
name:
description: 'Account name.
'
maxLength: 70
type: string
notes:
description: 'Notes about the account. These notes are only visible to Zuora users.
'
maxLength: 65535
type: string
parentId:
description: Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled.
type: string
paymentGateway:
description: 'The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.
'
maxLength: 40
type: string
paymentMethod:
$ref: '#/definitions/PostOrderAccountPaymentMethod'
paymentTerm:
description: 'Name of the payment term associated with the account. For example, "Net 30". The payment term determines the due dates of invoices.
'
type: string
soldToContact:
$ref: '#/definitions/SoldToContact'
taxInfo:
$ref: '#/definitions/TaxInfo'
required:
- name
- currency
- billCycleDay
- billToContact
type: object
notes:
description: 'Notes about the subscription. These notes are only visible to Zuora users.
'
maxLength: 500
type: string
paymentTerm:
description: "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
subscribeToProducts:
description: "List of offers or rate plans associated with the subscription.\n- For a rate plan, the following fields are available:\n - `chargeOverrides`\n - `clearingExistingFeatures`\n - `customFields`\n - `externallyManagedPlanId`\n - `newRatePlanId`\n - `productRatePlanId`\n - `subscriptionProductFeatures`\n - `uniqueToken`\n- For an offer, the following fields are available:\n - `customFields`\n - `newSubscriptionOfferId`\n - `newSubscriptionOfferNumber`\n - `productOfferId`\n - `productOfferNumber`\n - `ratePlanOverrides`\n - `subscriptionOfferUniqueToken`\n \n"
items:
$ref: '#/definitions/subscribeToProduct'
type: array
subscribeToRatePlans:
description: 'List of rate plans associated with the subscription.
**Note**: The `subscribeToRatePlans` field has been deprecated, this field is replaced by the `subscribeToProducts` field that supports both Rate Plans and Offers. In a new order request, you can use either `subscribeToRatePlans` or `subscribeToProducts`, not both.
'
items:
$ref: '#/definitions/RatePlanOverride'
type: array
subscriptionNumber:
description: 'Subscription number of the subscription. For example, A-S00000001.
If you do not set this field, Zuora will generate the subscription number.
'
maxLength: 100
type: string
subscriptionOwnerAccountNumber:
description: 'Account number of an existing account that will own the subscription. For example, A00000001.
If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.
'
maxLength: 70
type: string
terms:
description: 'Container for the terms and renewal settings of the subscription.
'
properties:
autoRenew:
description: 'Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.
'
type: boolean
initialTerm:
description: 'Information about the first term of the subscription.
'
properties:
period:
description: 'Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.
'
type: integer
periodType:
description: 'Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.
'
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'Start date of the first term, in YYYY-MM-DD format.
'
format: date
type: string
termType:
description: 'Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.
'
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
renewalSetting:
description: 'Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.
* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.
* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.
'
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
description: 'List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
'
items:
$ref: '#/definitions/RenewalTerm'
type: array
required:
- initialTerm
- renewalTerms
type: object
title: createSubscription
type: object
SubscriptionObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Subscription object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Subscription object.
'
title: subscriptionFieldsCustom
type: object
DiscountApplyDetail:
properties:
productRatePlanChargeId:
description: 'Product Rate Plan Charge Id of the discount apply to.
'
type: string
productRatePlanId:
description: 'Product Rate Plan Id of the discount apply to.
'
type: string
required:
- productRatePlanId
- productRatePlanChargeId
title: discountApplyDetail
type: object
PreviewOrderCreateSubscription:
description: 'Information about an order action of type `CreateSubscription`.
'
properties:
billToContactId:
description: "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
currency:
description: "The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.\n\nAll subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.\n\n**Note**: \n This field is available only if you have the Multiple Currencies feature enabled.\n"
maxLength: 3
type: string
invoiceSeparately:
description: 'Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.
'
type: boolean
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
newSubscriptionOwnerAccount:
description: 'Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.
**Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
If you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.
'
properties:
accountNumber:
description: 'Account number. For example, A00000001.
'
maxLength: 70
type: string
additionalEmailAddresses:
description: 'List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.
'
maxLength: 1200
type: string
allowInvoiceEdit:
description: "Indicates if associated invoices can be edited.\nValues are: \n\n* `true`\n* `false` (default)\n"
type: boolean
autoPay:
description: 'Specifies whether future payments are automatically billed when they are due.
'
type: boolean
batch:
description: 'Name of the billing batch that the account belongs to. For example, Batch1.
'
type: string
billCycleDay:
description: 'Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
'
maximum: 31
minimum: 0
type: integer
billToContact:
$ref: '#/definitions/BillToContactPostOrder'
communicationProfileId:
description: 'Internal identifier of the communication profile that Zuora uses when sending notifications to the account''s contacts.
'
type: string
creditCard:
$ref: '#/definitions/creditCard'
creditMemoTemplateId:
description: '**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
'
type: string
crmId:
description: 'External identifier of the account in a CRM system.
'
maxLength: 100
type: string
currency:
description: 'ISO 3-letter currency code (uppercase). For example, USD.
'
type: string
customFields:
$ref: '#/definitions/AccountObjectCustomFields'
customerServiceRepName:
description: 'Name of the account''s customer service representative, if applicable.
'
maxLength: 50
type: string
debitMemoTemplateId:
description: '**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
'
type: string
hpmCreditCardPaymentMethodId:
description: 'The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.
If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,
but not both.
For a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions) for this payment method is already enabled.
'
type: string
invoiceDeliveryPrefsEmail:
description: "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account. \n"
type: boolean
invoiceDeliveryPrefsPrint:
description: "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
type: boolean
invoiceTemplateId:
description: 'Internal identifier of the invoice template that Zuora uses when generating invoices for the account.
'
type: string
name:
description: 'Account name.
'
maxLength: 255
type: string
notes:
description: 'Notes about the account. These notes are only visible to Zuora users.
'
maxLength: 65535
type: string
parentId:
description: Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled.
type: string
paymentGateway:
description: 'The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.
'
maxLength: 40
type: string
paymentMethod:
$ref: '#/definitions/PostOrderAccountPaymentMethod'
paymentTerm:
description: 'Name of the payment term associated with the account. For example, "Net 30". The payment term determines the due dates of invoices.
'
type: string
purchaseOrderNumber:
description: 'The number of the purchase order associated with this account. Purchase order information generally comes from customers.
'
maxLength: 100
type: string
salesRep:
description: 'The name of the sales representative associated with this account, if applicable.
'
maxLength: 50
type: string
soldToContact:
$ref: '#/definitions/SoldToContactPostOrder'
taxInfo:
$ref: '#/definitions/TaxInfo'
required:
- name
- currency
- billCycleDay
- billToContact
type: object
notes:
description: 'Notes about the subscription. These notes are only visible to Zuora users.
'
maxLength: 500
type: string
paymentTerm:
description: "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
subscribeToRatePlans:
description: 'List of rate plans associated with the subscription.
'
items:
$ref: '#/definitions/PreviewOrderRatePlanOverride'
type: array
subscriptionNumber:
description: 'Subscription number of the subscription. For example, A-S00000001.
If you do not set this field, Zuora will generate the subscription number.
'
maxLength: 100
type: string
subscriptionOwnerAccountNumber:
description: 'Account number of an existing account that will own the subscription. For example, A00000001.
If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.
'
maxLength: 70
type: string
terms:
description: 'Container for the terms and renewal settings of the subscription.
'
properties:
autoRenew:
description: 'Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.
'
type: boolean
initialTerm:
description: 'Information about the first term of the subscription.
'
properties:
period:
description: 'Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.
'
type: integer
periodType:
description: 'Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.
'
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'Start date of the first term, in YYYY-MM-DD format.
'
format: date
type: string
termType:
description: 'Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.
'
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
renewalSetting:
description: 'Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.
* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.
* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.
'
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
description: 'List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
'
items:
$ref: '#/definitions/RenewalTerm'
type: array
required:
- initialTerm
type: object
title: createSubscription
type: object
CreateOrderPricingUpdate:
properties:
chargeModelData:
allOf:
- $ref: '#/definitions/ChargeModelDataOverride'
description: 'Container for charge model configuration data.
**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
'
discount:
allOf:
- $ref: '#/definitions/DiscountPricingUpdate'
description: 'Pricing information about a discount charge.
'
recurringDeliveryBased:
allOf:
- $ref: '#/definitions/RecurringDeliveryPricingUpdate'
description: 'This field is only available if you have the Delivery Pricing charge model enabled.
**Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**.
'
recurringFlatFee:
allOf:
- $ref: '#/definitions/RecurringFlatFeePricingUpdate'
description: 'Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
recurringPerUnit:
allOf:
- $ref: '#/definitions/RecurringPerUnitPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
'
recurringTiered:
allOf:
- $ref: '#/definitions/RecurringTieredPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.
'
recurringVolume:
allOf:
- $ref: '#/definitions/RecurringVolumePricingUpdate'
description: 'Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.
'
usageFlatFee:
allOf:
- $ref: '#/definitions/UsageFlatFeePricingUpdate'
description: 'Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
usageOverage:
allOf:
- $ref: '#/definitions/UsageOveragePricingUpdate'
description: 'Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.
'
usagePerUnit:
allOf:
- $ref: '#/definitions/UsagePerUnitPricingUpdate'
description: 'Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed.
'
usageTiered:
allOf:
- $ref: '#/definitions/UsageTieredPricingUpdate'
description: 'Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.
'
usageTieredWithOverage:
allOf:
- $ref: '#/definitions/UsageTieredWithOveragePricingUpdate'
description: 'Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.
'
usageVolume:
allOf:
- $ref: '#/definitions/UsageVolumePricingUpdate'
description: 'Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.
'
type: object
RecurringVolumePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
quantity:
minimum: 0
type: number
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
UsageFlatFeePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Price of the charge.
'
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
title: usageFlatFee
PostOrderAccountPaymentMethod:
allOf:
- properties:
type:
description: 'Type of payment method. The following types of the payment method are supported:
* `CreditCard` - Credit card payment method.
* `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.
* `ACH` - ACH payment method.
* `SEPA` - Single Euro Payments Area.
* `Betalingsservice` - Direct Debit DK.
* `Autogiro` - Direct Debit SE.
* `Bacs` - Direct Debit UK.
* `Becs` - Direct Entry AU.
* `Becsnz` - Direct Debit NZ.
* `PAD` - Pre-Authorized Debit.
* `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.
* `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.
* `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.
* `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.
* `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details.
* `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.
* `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.
* You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.
'
type: string
required:
- type
type: object
- $ref: '#/definitions/CreatePMPayPalECPayPalNativeECPayPalCP'
- $ref: '#/definitions/CreatePaymentMethodPayPalAdaptive'
- $ref: '#/definitions/CreatePaymentMethodCreditCard'
- $ref: '#/definitions/CreatePaymentMethodACH'
- $ref: '#/definitions/CreatePaymentMethodCommon'
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
- $ref: '#/definitions/CreatePaymentMethodBankTransfer'
- $ref: '#/definitions/CreatePaymentMethodCCReferenceTransaction'
- $ref: '#/definitions/CreatePaymentMethodApplePayAdyen'
- $ref: '#/definitions/CreatePaymentMethodGooglePayAdyenChase'
description: 'Payment method to create for this new account. Supports all the payment methods that are supported in the "Create a payment method" operation. See [Create a payment method](/api-references/api/operation/POST_PaymentMethods) for more information.
'
OrderDeltaTcb:
allOf:
- $ref: '#/definitions/OrderDeltaMetric'
- properties:
orderLineItemId:
description: 'The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for a Rate Plan Charge.
'
format: UUID
type: string
type: object
description: 'Order Delta Tcb. This is a metric that reflects the change to the estimated billing on Rate Plan Charge object, or the estimated billing for an Order Line Item as the result of the order
'
type: object
CreatePaymentMethodCCReferenceTransaction:
properties:
creditCardMaskNumber:
description: 'The masked credit card number, such as:
```
*********1112
```
This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.
Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.
'
maxLength: 19
type: string
secondTokenId:
description: "A gateway unique identifier that replaces sensitive payment method data. \n\n`secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method.\n"
type: string
tokenId:
description: "A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.\n\nWhen `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.\n\nThe values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.\n\n**Note:** \n - When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field.\n - When creating the following payment methods, if you need to pass in token information, use the `tokens` > `tokenId` and `tokens` > `secondTokenId` fields instead of this `tokenId` field:\n - SEPA on Adyen Integration v2.0\n - BACS on Stripe v2\n \n"
type: string
type: object
CreateOrderChargeOverride:
description: 'Charge associated with a rate plan.
'
properties:
accountReceivableAccountingCode:
description: 'The accountReceivableAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.
'
type: string
adjustmentLiabilityAccountingCode:
description: 'The adjustmentLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
adjustmentRevenueAccountingCode:
description: 'The adjustmentRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
billing:
description: 'Billing information about the charge.
'
properties:
billCycleDay:
description: 'Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.
'
maximum: 31
minimum: 0
type: integer
billCycleType:
description: "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
enum:
- DefaultFromCustomer
- SpecificDayofMonth
- SubscriptionStartDay
- ChargeTriggerDay
- SpecificDayofWeek
type: string
billingPeriod:
description: 'Billing frequency of the charge. The value of this field controls the duration of each billing period.
If the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.
'
enum:
- Month
- Quarter
- Semi_Annual
- Annual
- Eighteen_Months
- Two_Years
- Three_Years
- Five_Years
- Specific_Months
- Subscription_Term
- Week
- Specific_Weeks
- Specific_Days
type: string
billingPeriodAlignment:
description: 'Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.
* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.
* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.
* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.
See the `billCycleType` field for information about how Zuora determines the billing day.
'
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
billingTiming:
description: 'Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).
'
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
specificBillingPeriod:
description: 'Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.
'
type: integer
weeklyBillCycleDay:
description: 'Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.
'
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
type: object
chargeModel:
description: 'The chargeModel of a standalone charge.
Supported charge models:
* `FlatFee`
* `PerUnit`
* `Volume`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
chargeNumber:
description: 'Charge number of the charge. For example, C-00000307.
If you do not set this field, Zuora will generate the charge number.
'
maxLength: 50
type: string
chargeType:
description: 'The chargeType of a standalone charge.
Supported charge types:
* `OneTime`
* `Recurring`
* `Usage`
* `DiscountFixedAmount`
* `DiscountPercentage`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
contractAssetAccountingCode:
description: 'The contractAssetAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractLiabilityAccountingCode:
description: 'The contractLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractRecognizedRevenueAccountingCode:
description: 'The contractRecognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
deferredRevenueAccountingCode:
description: 'The deferredRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
description:
description: 'Description of the charge.
'
maxLength: 500
type: string
drawdownRate:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).
'
type: number
endDate:
$ref: '#/definitions/EndConditions'
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in a Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isRollover:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The value is either "True" or "False". It determines whether the rollover fields are needed.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
name:
description: 'The name of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
pobPolicy:
description: 'The pobPolicy of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
prepaidQuantity:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).
'
type: number
pricing:
description: 'Pricing information about the charge.
'
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingOverride'
oneTimeFlatFee:
$ref: '#/definitions/OneTimeFlatFeePricingOverride'
oneTimePerUnit:
$ref: '#/definitions/OneTimePerUnitPricingOverride'
oneTimeTiered:
$ref: '#/definitions/OneTimeTieredPricingOverride'
oneTimeVolume:
$ref: '#/definitions/OneTimeVolumePricingOverride'
recurringDeliveryBased:
$ref: '#/definitions/RecurringDeliveryPricingOverride'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingOverride'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingOverride'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingOverride'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingOverride'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingOverride'
usageOverage:
$ref: '#/definitions/UsageOveragePricingOverride'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingOverride'
usageTiered:
$ref: '#/definitions/UsageTieredPricingOverride'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingOverride'
usageVolume:
$ref: '#/definitions/UsageVolumePricingOverride'
type: object
productCategory:
description: 'The productCategory of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productClass:
description: 'The productClass of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productFamily:
description: 'The productFamily of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productLine:
description: 'The productLine of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productRatePlanChargeId:
description: 'Internal identifier of the product rate plan charge that the charge is based on.
'
type: string
productRatePlanChargeNumber:
description: 'Number of a product rate-plan charge for this subscription.
'
type: string
recognizedRevenueAccountingCode:
description: 'The recognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
revRecCode:
description: 'Revenue Recognition Code
'
maxLength: 70
type: string
revRecTriggerCondition:
description: "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
enum:
- Contract Effective Date
- Service Activation Date
- Customer Acceptance Date
type: string
revenueRecognitionRuleName:
description: 'Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.
'
type: string
rolloverApply:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the priority of rollover, which is either first or last.
'
enum:
- ApplyFirst
- ApplyLast
type: string
rolloverPeriodLength:
default: null
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period length of the rollover fund.
'
type: integer
rolloverPeriods:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the number of rollover periods, it is restricted to 3.
'
type: number
startDate:
$ref: '#/definitions/CreateOrderTriggerParams'
taxCode:
description: 'The taxCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
taxMode:
description: "The taxMode of a standalone charge. \n\nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"
type: string
unBilledReceivablesAccountingCode:
description: 'The unBilledReceivablesAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
uniqueToken:
description: 'Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
'
maxLength: 50
type: string
validityPeriodType:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
'
enum:
- SUBSCRIPTION_TERM
- ANNUAL
- SEMI_ANNUAL
- QUARTER
- MONTH
type: string
required:
- productRatePlanChargeId
title: charge
type: object
processingOptionsOrdersAsync:
description: 'The container for billing processing options and payment processing options.
**Note:** This field is not supported in draft orders.
'
properties:
applicationOrder:
description: "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
items:
type: string
type: array
applyCredit:
description: '
- If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices
**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
'
type: boolean
applyCreditBalance:
description: 'Indicates if any credit balance on a customer''s account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.
'
type: boolean
billingOptions:
properties:
creditMemoReasonCode:
description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.
type: string
documentDate:
description: 'The invoice date displayed on the invoice.
'
format: date
type: string
generateDraftInvoice:
description: 'Indicates if the current request needs to generate a draft invoice.
Values are:
* `true`
* `false` (default)
'
type: boolean
targetDate:
description: 'Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).
'
format: date
type: string
type: object
collectPayment:
description: 'Indicates if the current request needs to collect payments. This value can not be ''true'' when ''runBilling'' flag is ''false''.
'
type: boolean
electronicPaymentOptions:
description: 'Container for the electronic payment options.
'
properties:
paymentGatewayId:
description: 'Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.
'
type: string
paymentMethodId:
description: 'Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.
'
type: string
type: object
runBilling:
description: 'Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.
'
type: boolean
type: object
CreateOrderUpdateProductTriggerParams:
description: 'Specifies when a charge becomes active.
'
properties:
specificTriggerDate:
description: "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nWhile this field is applicable, for the `updateProduct` order action, if the Pending order feature as above is not enabled, this field must not be set to null.\n"
format: date
type: string
triggerEvent:
description: 'Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog.
If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.
'
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
- SpecificDate
type: string
title: startDate
type: object
RemoveProduct:
description: "Information about an order action of type `RemoveProduct`.\n\nEither a rate plan or offer can be removed from a subscription through one order action, but not both; otherwise, an error occurs.\n- If you remove a rate plan, specify the following fields:\n - `externalCatalogPlanId`\n - `ratePlanId`\n - `subscriptionRatePlanNumber`\n - `productRatePlanNumber`\n - `uniqueToken`\n- If you remove an offer, specify the following fields:\n - `subscriptionOfferNumber`\n - `subscriptionOfferId`\n - `subscriptionOfferUniqueToken`\n"
properties:
externalCatalogPlanId:
description: 'An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.
**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'ID of the rate plan to remove. This can be the latest version or any history version of ID.
'
type: string
subscriptionOfferId:
description: "Internal identifier of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
subscriptionOfferNumber:
description: "Number of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
maxLength: 100
type: string
subscriptionOfferUniqueToken:
description: "Unique identifier of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
uniqueToken:
description: Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
type: string
title: removeProduct
type: object
PUTOrderRequestType:
example:
description: This is a description for the Order.
existingAccountNumber: A00000001
orderDate: '2017-01-01'
orderLineItems:
- billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billingTrigger: BillImmediately
chargeAmountPerUnit: 50
customFields:
someField__c: some string
deferredRevenueAccountingCode: Unearned Revenues
description: With Dual Stereo Microphones, HD 1080p, Black
itemName: webcam
itemType: Product
listPricePerUnit: 59
productCode: C9201
purchaseOrderNumber: 960-000764
quantity: 2
recognizedRevenueAccountingCode: Earned Revenues
revenueRecognitionRule: recognized upon invoice
soldTo: 4028fc828244a0ac018244dfc9a90bee
taxCode: '8018'
taxMode: TaxInclusive
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
orderNumber: OM-00001
processingOptions:
applyCreditBalance: true
billingOptions:
creditMemoReasonCode: Unsatisfactory service
targetDate: '2017-08-01'
collectPayment: true
electronicPaymentOptions:
paymentGatewayId: 2c9890186cb7c157016cd18c72370999
paymentMethodId: 2c9890186cb7c157016cd18c6f690999
runBilling: true
subscriptions:
- orderActions:
- createSubscription:
billToContactId: efbff07e6290dfb8016291003bd00dda
invoiceTemplateId: 2c9081a03c638994013c63978baf002b
paymentTerm: Net 30
sequenceSetId: 6abcc30846de11e990900242ac1f0003
soldToContactId: efbff07e6290dfb8016291003bd00ddb
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb8016291003bd00dda
subscriptionNumber: SM-00001
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb8016291003bd00dda
subscriptionNumber: SM-00002
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-02-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-02-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb80162910024c80dd5
subscriptionNumber: SM-00003
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-04-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- chargeOverrides:
- productRatePlanChargeId: efbff07e6290dfb80162910024d80dd7
startDate:
triggerEvent: SpecificDate
productRatePlanId: efbff07e6290dfb80162910024c80dd5
uniqueToken: Sugar-free Monthly
subscriptionNumber: SM-00004
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-04-01'
type: CreateSubscription
- orderActions:
- suspend:
suspendPeriods: 2
suspendPeriodsType: Week
suspendPolicy: FixedPeriodsFromToday
triggerDates:
- name: ContractEffective
triggerDate: '2018-01-01'
- name: ServiceActivation
triggerDate: '2018-01-01'
- name: CustomerAcceptance
triggerDate: '2018-01-01'
type: Suspend
subscriptionNumber: SM-00005
- orderActions:
- resume:
extendsTerm: true
resumePolicy: SpecificDate
resumeSpecificDate: '2018-10-01'
triggerDates:
- name: ContractEffective
triggerDate: '2018-01-01'
- name: ServiceActivation
triggerDate: '2018-01-01'
- name: CustomerAcceptance
triggerDate: '2018-01-01'
type: Resume
subscriptionNumber: SM-00006
properties:
category:
default: NewSales
description: 'Category of the order to indicate a product sale or return. Default value is `NewSales`.
'
enum:
- NewSales
- Return
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: 'The account number that this order will be created under.
Note that this actually specifies the invoice owner account of the subscriptions included in this order.
'
maxLength: 70
type: string
externallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
newAccount:
$ref: '#/definitions/Account'
orderDate:
description: The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null.
format: date
type: string
orderLineItems:
description: "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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. \n\nWith 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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
items:
$ref: '#/definitions/CreateOrderOrderLineItem'
type: array
orderNumber:
description: "The order number of the new order. If not provided, system will auto-generate a number for this order. \n**Note:** Make sure the order number does not contain a slash. \n"
maxLength: 100
type: string
processingOptions:
$ref: '#/definitions/processingOptionsOrders'
reasonCode:
description: 'Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.
'
maxLength: 255
type: string
schedulingOptions:
description: "Information of scheduled order. \n\n**Note**: The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.\n"
properties:
scheduledDate:
description: 'The date for the order scheduled.
'
format: date
type: string
scheduledDatePolicy:
description: Date policy of the scheduled order.
enum:
- SpecificDate
type: string
type: object
status:
description: 'The status of the order. The default value is `Completed`. The following values are supported:
- `Draft`: The order is in draft status.
- `Pending`: The order is in pending status.
- `Completed`: The order is in completed status.
- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.
- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.
- `Failed`: The scheduled order has failed.
**Note**: The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.
'
enum:
- Draft
- Pending
- Completed
- Scheduled
type: string
subscriptions:
description: Each item includes a set of order actions, which will be applied to the same base subscription.
items:
properties:
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
orderActions:
description: The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.
items:
$ref: '#/definitions/CreateOrderOrderAction'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
ramp:
$ref: '#/definitions/RampRequest'
subscriptionNumber:
description: 'Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.
'
type: string
type: object
type: array
required:
- orderDate
type: object
RampChargeRequest:
properties:
chargeNumber:
description: The number of the rate plan charge.
type: string
uniqueToken:
description: 'Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
'
type: string
title: RampCharge
type: object
CreateOfferRatePlanOverride:
description: "Information about an order action of type `addProduct`. \n"
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/CreateOrderChargeOverride'
type: array
clearingExistingFeatures:
description: "Specifies whether all features in the rate plan will be cleared. \n"
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externalCatalogPlanId:
description: 'An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.
**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
sequence:
description: 'The sequence in offer rateplan override. If there are more than one same rateplan in the offer, please provide the sequence.
'
type: integer
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/CreateOrderRatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
title: ratePlan
type: object
OfferUpdate:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
ratePlanUpdates:
items:
$ref: '#/definitions/GetOfferRatePlanUpdate'
type: array
subscriptionOfferId:
description: "Internal identifier of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
subscriptionOfferNumber:
description: "Number of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
subscriptionOfferUniqueToken:
description: "Unique identifier of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
title: updateOffer
type: object
CreateOrderSuspend:
description: 'Information about an order action of type `Suspend`.
'
properties:
suspendPeriods:
description: "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType` field. \n\nThe total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
type: integer
suspendPeriodsType:
description: "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods` field.\n\nThe period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
enum:
- Day
- Week
- Month
- Year
type: string
suspendPolicy:
description: 'Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information.
'
enum:
- Today
- EndOfLastInvoicePeriod
- FixedPeriodsFromToday
- SpecificDate
type: string
suspendSpecificDate:
description: 'This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`.
A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription''s contract effective date or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version) than the subscription''s term end date.
'
format: date
type: string
required:
- suspendPolicy
title: Suspend
type: object
UsageTieredWithOveragePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
numberOfPeriods:
description: 'Number of periods that Zuora considers when calculating overage charges with overage smoothing.
'
minimum: 1
type: integer
overagePrice:
description: 'Price per overage unit consumed.
'
type: number
overageUnusedUnitsCreditOption:
description: 'Specifies whether to credit the customer for unused units.
If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.
'
enum:
- NoCredit
- CreditBySpecificRate
type: string
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
unusedUnitsCreditRates:
description: 'Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.
'
title: usageTieredWithOverage
PreviewOptions:
properties:
previewNumberOfPeriods:
description: 'The number of periods to preview when the value of the `previewThroughType` field is set to `NumberOfPeriods`.
'
minLength: 1
type: integer
previewThruType:
description: "The options on how the preview through date is calculated. Available for preview only. \n- If you set this field to `SpecificDate`, you must specify a specific date in the `specificPreviewThruDate` field. If you also set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than `specificPreviewThruDate` are returned.\n\n- If you set this field to `NumberOfPeriods`, you must use the `previewNumberOfPeriods` field to specify how many periods you want to preview. In case the order only contains an order line item but not contains a subscription, if you also set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than today are returned.\n\n- The `TermEnd` option is invalid when any subscription included in this order is evergreen. In case the order only contains an order line item but not contains a subscription, if you set this field to `TermEnd` and set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than today are returned.\n"
enum:
- SpecificDate
- TermEnd
- NumberOfPeriods
type: string
previewTypes:
description: 'One or more types of the preview. It can include:
* ChargeMetrics: charge level metrics will be returned in the response, including: `cmrr`, `tcv`, `tcb`, and `tax`.
* BillingDocs: `invoices` and `creditMemos` will be returned in the response. Note `creditMemos` is only available if the Invoice Settlement feature is enabled.
* OrderDeltaMetrics: order delta metrics will be returned in the response, including: `orderDeltaMrr`, `orderDeltaTcb` and `orderDeltaTcv`.
* OrderMetrics: order metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv`, and `elp`. **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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.
* RampMetrics: ramp metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv` metrics for each charge and each ramp interval.
* RampDeltaMetrics: ramp metrics changes will be returned in the response, including: `deltaQuantity`, `deltaMrr`, `deltaTcb`, `deltaTcv` metrics for each charge and each ramp interval.
'
items:
enum:
- ChargeMetrics
- BillingDocs
- OrderDeltaMetrics
- OrderMetrics
- RampMetrics
- RampDeltaMetrics
type: string
type: array
specificPreviewThruDate:
description: 'The end date of the order preview. You can preview the invoice charges through the preview through date. (Invoice preview only)
**Note:** This field is only applicable if the ''previewThruType'' field is set to ''SpecificDate''.
'
format: date
type: string
type: object
CreateSubscribeToProduct:
allOf:
- $ref: '#/definitions/CreateOrderRatePlanOverride'
- $ref: '#/definitions/CreateOrderProductOverride'
title: createSubscribeToProduct
type: object
GetAllOrdersResponseType:
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists; otherwise absent.
'
format: URL
type: string
orders:
items:
$ref: '#/definitions/Order'
type: array
success:
description: 'Indicates whether the call succeeded.
'
type: boolean
type: object
PutOrderCancelResponse:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
accountNumber:
description: The account number for the order.
type: string
cancelReason:
description: The reason for cancelling the order.
type: string
orderNumber:
description: The order number of the order created.
type: string
status:
description: Status of the order. `Cancelled` is only valid value.
enum:
- Cancelled
type: string
type: object
OrderAction:
description: Represents the processed order action.
properties:
addProduct:
allOf:
- $ref: '#/definitions/RatePlanOverride'
- $ref: '#/definitions/OfferOverride'
description: "Either a rate plan or offer can be added to a subscription through one order action, but not both; otherwise, an error occurs.\n - For a rate plan, the following fields are available:\n - `chargeOverrides`\n - `clearingExistingFeatures`\n - `customFields`\n - `externallyManagedPlanId`\n - `newRatePlanId` \n - `productRatePlanId`\n - `subscriptionProductFeatures`\n - `uniqueToken`\n - For an offer, the following fields are available:\n - `customFields`\n - `newSubscriptionOfferId`\n - `newSubscriptionOfferNumber`\n - `productOfferId`\n - `productOfferNumber`\n - `ratePlanOverrides`\n - `subscriptionOfferUniqueToken`\n"
cancelSubscription:
$ref: '#/definitions/CancelSubscription'
changePlan:
$ref: '#/definitions/ChangePlan'
changeReason:
description: 'The change reason set for an order action when an order is created.
'
type: string
createSubscription:
$ref: '#/definitions/CreateSubscription'
customFields:
$ref: '#/definitions/OrderActionObjectCustomFields'
id:
description: The Id of the order action processed in the order.
type: string
orderItems:
description: "The `orderItems` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
items:
$ref: '#/definitions/OrderItem'
type: array
orderMetrics:
description: "The container for order metrics.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n\n**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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/).\n\nWhereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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.\n"
items:
$ref: '#/definitions/orderMetric'
type: array
ownerTransfer:
$ref: '#/definitions/OwnerTransfer'
removeProduct:
$ref: '#/definitions/RemoveProduct'
renewSubscription:
$ref: '#/definitions/RenewSubscription'
resume:
$ref: '#/definitions/GetOrderResume'
sequence:
description: The sequence of the order actions processed in the order.
type: integer
suspend:
$ref: '#/definitions/GetOrderSuspend'
termsAndConditions:
$ref: '#/definitions/TermsAndConditions'
triggerDates:
description: "Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf [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 `ServiceActivation` field is not set for a `CreateSubscription` order action, a `Pending` order and a `Pending Activation` subscription are created.\n\nIf [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 `CustomerAcceptance` field is not set for a `CreateSubscription` order action, a `Pending` order and 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 a `Pending Activation` subscription are created instead.\n\nIf [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 `ServiceActivation` field is not set for either of the following order actions, 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](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nIf [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 `CustomerAcceptance` field is not set for either of the following order actions, 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](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
items:
$ref: '#/definitions/TriggerDate'
type: array
type:
description: 'Type of the order action.
**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.
'
enum:
- CreateSubscription
- TermsAndConditions
- AddProduct
- UpdateProduct
- RemoveProduct
- RenewSubscription
- CancelSubscription
- OwnerTransfer
- Suspend
- Resume
- ChangePlan
type: string
updateProduct:
allOf:
- $ref: '#/definitions/RatePlanUpdate'
- $ref: '#/definitions/OfferUpdate'
description: "Either a rate plan or offer can be updated in a subscription through one order action, but not both; otherwise, an error occurs.\n - For a rate plan, the following fields are available:\n - `chargeUpdates`\n - `clearingExistingFeatures`\n - `customFields`\n - `externallyManagedPlanId`\n - `newRatePlanId`\n - `ratePlanId`\n - `specificUpdateDate`\n - `subscriptionProductFeatures`\n - `uniqueToken`\n - For an offer, the following fields are available:\n - `customFields`\n - `ratePlanUpdates`\n - `subscriptionOfferId`\n - `subscriptionOfferNumber`\n - `subscriptionOfferUniqueToken`\n"
type: object
RecurringVolumePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPriceBase:
description: 'Specifies the duration of each recurring period.
'
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
priceIntervals:
description: "List of tier prices with intervals. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer.\n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
items:
$ref: '#/definitions/PriceIntervalWithTiers'
type: array
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
specificListPriceBase:
description: "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the Annual List Price feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
format: int32
maximum: 200
minimum: 1
type: integer
tiers:
description: 'List of variable pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
type: object
description: 'Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.
'
title: recurringVolume
CancelSubscription:
description: 'Information about an order action of type `CancelSubscription`.
'
properties:
cancellationEffectiveDate:
format: date
type: string
cancellationPolicy:
enum:
- EndOfCurrentTerm
- EndOfLastInvoicePeriod
- SpecificDate
type: string
required:
- cancellationPolicy
title: cancelSubscription
type: object
PreviewResult:
description: The result of each type of preview. Returned only when the current request is preview call.
properties:
chargeMetrics:
items:
properties:
charges:
items:
$ref: '#/definitions/ChargePreviewMetrics'
type: array
subscriptionNumber:
description: 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.
type: string
type: object
type: array
creditMemos:
description: This field is only available if you have the Invoice Settlement feature enabled.
items:
properties:
amount:
type: number
amountWithoutTax:
type: number
creditMemoItems:
items:
$ref: '#/definitions/InvoiceItemPreviewResult'
type: array
targetDate:
format: date
type: string
taxAmount:
type: number
type: object
type: array
invoices:
items:
properties:
amount:
type: number
amountWithoutTax:
type: number
invoiceItems:
items:
$ref: '#/definitions/InvoiceItemPreviewResult'
type: array
targetDate:
format: date
type: string
taxAmount:
type: number
type: object
type: array
orderDeltaMetrics:
description: "**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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/).\n"
properties:
orderDeltaMrr:
items:
$ref: '#/definitions/OrderDeltaMrr'
type: array
orderDeltaTcb:
items:
$ref: '#/definitions/OrderDeltaTcb'
type: array
orderDeltaTcv:
items:
$ref: '#/definitions/OrderDeltaTcv'
type: array
type: object
orderMetrics:
description: "**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr) \n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv) \n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb) \n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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/). \n\nWhereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_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.\n"
items:
properties:
orderActions:
items:
properties:
orderItems:
description: "The `orderItems` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
items:
$ref: '#/definitions/OrderItem'
type: array
orderMetrics:
description: "The container for order metrics.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
items:
$ref: '#/definitions/orderMetric'
type: array
sequence:
type: string
type:
type: string
type: object
type: array
subscriptionNumber:
type: string
type: object
type: array
rampMetrics:
description: '**Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_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://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
The ramp metrics.
'
items:
$ref: '#/definitions/OrderRampMetrics'
type: array
type: object
PreviewOrderPricingUpdate:
properties:
chargeModelData:
allOf:
- $ref: '#/definitions/ChargeModelDataOverride'
description: 'Container for charge model configuration data.
**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
'
discount:
allOf:
- $ref: '#/definitions/DiscountPricingUpdate'
description: 'Pricing information about a discount charge.
'
recurringFlatFee:
allOf:
- $ref: '#/definitions/RecurringFlatFeePricingUpdate'
description: 'Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
recurringPerUnit:
allOf:
- $ref: '#/definitions/RecurringPerUnitPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
'
recurringTiered:
allOf:
- $ref: '#/definitions/RecurringTieredPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.
'
recurringVolume:
allOf:
- $ref: '#/definitions/RecurringVolumePricingUpdate'
description: 'Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.
'
usageFlatFee:
allOf:
- $ref: '#/definitions/UsageFlatFeePricingUpdate'
description: 'Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
usageOverage:
allOf:
- $ref: '#/definitions/UsageOveragePricingUpdate'
description: 'Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.
'
usagePerUnit:
allOf:
- $ref: '#/definitions/UsagePerUnitPricingUpdate'
description: 'Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed.
'
usageTiered:
allOf:
- $ref: '#/definitions/UsageTieredPricingUpdate'
description: 'Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.
'
usageTieredWithOverage:
allOf:
- $ref: '#/definitions/UsageTieredWithOveragePricingUpdate'
description: 'Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.
'
usageVolume:
allOf:
- $ref: '#/definitions/UsageVolumePricingUpdate'
description: 'Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.
'
type: object
PreviewOrderRatePlanUpdate:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
chargeUpdates:
description: 'Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.
When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update.
'
items:
$ref: '#/definitions/PreviewOrderChargeUpdate'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'The id of the rate plan to be updated. It can be the latest version or any history version id.
'
type: string
specificUpdateDate:
description: '
The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.
See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
'
format: date
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/CreateOrderRatePlanFeatureOverride'
type: array
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
uniqueToken:
description: 'A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
'
type: string
title: updateProduct
type: object
RatePlanUpdate:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
chargeUpdates:
description: 'Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.
'
items:
$ref: '#/definitions/ChargeUpdate'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
newRatePlanId:
description: 'Internal identifier of the updated rate plan in the new subscription version.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'Internal identifier of the rate plan that was updated. It can be the latest version or any history version id.
'
type: string
specificUpdateDate:
description: '
The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.
See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
'
format: date
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/RatePlanFeatureOverride'
type: array
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
uniqueToken:
description: 'A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
'
type: string
title: updateProduct
type: object
UsagePerUnitPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Per-unit price of the charge.
'
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
ratingGroup:
description: "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
type: string
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed.
'
title: usagePerUnit
POSTOrderAsyncRequestType:
example:
description: This is a description for the Order.
existingAccountNumber: A00000001
orderDate: '2017-01-01'
orderLineItems:
- billingTrigger: BillImmediately
chargeAmountPerUnit: 50
customFields:
someField__c: some string
deferredRevenueAccountingCode: Unearned Revenues
description: With Dual Stereo Microphones, HD 1080p, Black
itemName: webcam
itemType: Product
listPricePerUnit: 59
ownerAccountNumber: AN_1683614809986
productCode: C9201
purchaseOrderNumber: 960-000764
quantity: 2
recognizedRevenueAccountingCode: Earned Revenues
revenueRecognitionRule: recognized upon invoice
soldTo: 4028fc828244a0ac018244dfc9a90bee
taxCode: '8018'
taxMode: TaxInclusive
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
orderNumber: OM-00001
processingOptions:
applyCreditBalance: true
billingOptions:
creditMemoReasonCode: Unsatisfactory service
targetDate: '2017-08-01'
collectPayment: true
electronicPaymentOptions:
paymentGatewayId: 2c9890186cb7c157016cd18c72370999
paymentMethodId: 2c9890186cb7c157016cd18c6f690999
runBilling: true
subscriptions:
- orderActions:
- createSubscription:
billToContactId: efbff07e6290dfb8016291003bd00dda
invoiceTemplateId: 2c9081a03c638994013c63978baf002b
paymentTerm: Net 30
sequenceSetId: 6abcc30846de11e990900242ac1f0003
soldToContactId: efbff07e6290dfb8016291003bd00ddb
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb8016291003bd00dda
subscriptionNumber: SM-00001
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb8016291003bd00dda
subscriptionNumber: SM-00002
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-02-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-02-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb80162910024c80dd5
subscriptionNumber: SM-00003
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-04-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- chargeOverrides:
- productRatePlanChargeId: efbff07e6290dfb80162910024d80dd7
startDate:
triggerEvent: SpecificDate
productRatePlanId: efbff07e6290dfb80162910024c80dd5
uniqueToken: Sugar-free Monthly
subscriptionNumber: SM-00004
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-04-01'
type: CreateSubscription
- orderActions:
- suspend:
suspendPeriods: 2
suspendPeriodsType: Week
suspendPolicy: FixedPeriodsFromToday
triggerDates:
- name: ContractEffective
triggerDate: '2018-01-01'
- name: ServiceActivation
triggerDate: '2018-01-01'
- name: CustomerAcceptance
triggerDate: '2018-01-01'
type: Suspend
subscriptionNumber: SM-00005
- orderActions:
- resume:
extendsTerm: true
resumePolicy: SpecificDate
resumeSpecificDate: '2018-10-01'
triggerDates:
- name: ContractEffective
triggerDate: '2018-01-01'
- name: ServiceActivation
triggerDate: '2018-01-01'
- name: CustomerAcceptance
triggerDate: '2018-01-01'
type: Resume
subscriptionNumber: SM-00006
properties:
category:
default: NewSales
description: 'Category of the order to indicate a product sale or return. Default value is `NewSales`.
'
enum:
- NewSales
- Return
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: 'The account number that this order will be created under.
Note that this actually specifies the invoice owner account of the subscriptions included in this order.
'
maxLength: 70
type: string
externallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
newAccount:
$ref: '#/definitions/Account'
orderDate:
description: The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null.
format: date
type: string
orderLineItems:
description: "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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. \n\nWith 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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
items:
$ref: '#/definitions/CreateOrderOrderLineItem'
type: array
orderNumber:
description: "The order number of the new order. If not provided, system will auto-generate a number for this order. \n**Note:** Make sure the order number does not contain a slash.\n"
maxLength: 100
type: string
processingOptions:
$ref: '#/definitions/processingOptionsOrdersAsync'
reasonCode:
description: 'Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.
'
maxLength: 255
type: string
subscriptions:
description: Each item includes a set of order actions, which will be applied to the same base subscription.
items:
properties:
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
orderActions:
description: The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.
items:
$ref: '#/definitions/CreateOrderOrderAction'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
ramp:
$ref: '#/definitions/RampRequest'
subscriptionNumber:
description: 'Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.
'
type: string
type: object
type: array
required:
- orderDate
type: object
POSTOrderPreviewRequestType:
example:
customFields: {}
description: This is a description for the Order.
existingAccountNumber: A00000101
orderDate: '2018-10-01'
orderLineItems:
- amountPerUnit: 50
billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billingTrigger: BillImmediately
customFields:
someField__c: some string
deferredRevenueAccountingCode: Unearned Revenues
description: With Dual Stereo Microphones, HD 1080p, Black
itemName: webcam
itemType: Product
listPricePerUnit: 59
productCode: C9201
purchaseOrderNumber: 960-000764
quantity: 2
recognizedRevenueAccountingCode: Earned Revenues
revenueRecognitionRule: recognized upon invoice
soldTo: 4028fc828244a0ac018244dfc9a90bee
taxCode: '8018'
taxMode: TaxInclusive
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
previewOptions:
previewThruType: SpecificDate
previewTypes:
- OrderMetrics
- BillingDocs
- ChargeMetrics
specificPreviewThruDate: '2019-01-01'
subscriptions:
- orderActions:
- triggerDates:
- name: ContractEffective
triggerDate: '2018-12-01'
- name: ServiceActivation
triggerDate: '2018-12-01'
- name: CustomerAcceptance
triggerDate: '2018-12-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- chargeNumber: C-00000210
pricing:
recurringPerUnit:
listPrice: 20
ratePlanId: 2c98919c67a5ae9d0167a68f8eb20262
subscriptionNumber: A-S00000100
- orderActions:
- suspend:
suspendPolicy: Today
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-01'
- name: ServiceActivation
triggerDate: '2018-12-01'
- name: CustomerAcceptance
triggerDate: '2018-12-01'
type: Suspend
subscriptionNumber: A-S00000101
- orderActions:
- resume:
extendsTerm: true
resumePeriods: 10
resumePeriodsType: Day
resumePolicy: FixedPeriodsFromSuspendDate
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-12'
- name: ServiceActivation
triggerDate: '2018-12-12'
- name: CustomerAcceptance
triggerDate: '2018-12-12'
type: Resume
subscriptionNumber: A-S00000102
properties:
category:
default: NewSales
description: 'Category of the order to indicate a product sale or return. Default value is `NewSales`.
'
enum:
- NewSales
- Return
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: "The account number that this order will be created under. \n\nNote that invoice owner account of the subscriptions included in this order should be the same with the account of the order.\n"
maxLength: 70
type: string
orderDate:
description: The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date.
format: date
type: string
orderLineItems:
description: "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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. \n\nWith 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. \n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
items:
$ref: '#/definitions/CreateOrderOrderLineItem'
type: array
orderNumber:
description: "The order number of this order. \n**Note:** Make sure the order number does not contain a slash.\n"
maxLength: 100
type: string
previewAccountInfo:
$ref: '#/definitions/PreviewAccountInfo'
previewOptions:
$ref: '#/definitions/PreviewOptions'
reasonCode:
description: 'Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.
'
maxLength: 255
type: string
subscriptions:
description: Each item includes a set of order actions, which will be applied to the same base subscription.
items:
properties:
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
orderActions:
description: The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.
items:
$ref: '#/definitions/PreviewOrderOrderAction'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
ramp:
$ref: '#/definitions/RampRequest'
subscriptionNumber:
description: 'Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.
'
type: string
type: object
type: array
required:
- orderDate
- previewOptions
type: object
CreateOrderTriggerParams:
description: 'Specifies when a charge becomes active.
'
properties:
periodsAfterChargeStart:
description: 'Duration of the discount charge in days, weeks, months, or years, depending on the value of the `startPeriodsType` field. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
type: integer
specificTriggerDate:
description: "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
format: date
type: string
startDatePolicy:
description: "Start date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation.\n\n- If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n- If the value of this field is `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\n**Notes**: \n - You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field. \n - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.\n"
enum:
- AlignToApplyToCharge
- SpecificDate
- EndOfLastInvoicePeriodOfApplyToCharge
- FixedPeriodAfterApplyToChargeStartDate
type: string
startPeriodsType:
description: 'Unit of time that the discount charge duration is measured in. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
enum:
- Days
- Weeks
- Months
- Years
type: string
triggerEvent:
description: 'Condition for the charge to become active.
If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.
'
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
- SpecificDate
type: string
title: startDate
type: object
RampResponse:
properties:
charges:
description: Container for the rate plan charges that are considered as part of the ramp deal.
items:
$ref: '#/definitions/RampChargeResponse'
type: array
description:
description: The short description of the ramp.
type: string
id:
description: The ID of the ramp.
type: string
intervals:
description: Container for the intervals that the ramp is split into in its timeline.
items:
$ref: '#/definitions/RampIntervalResponse'
type: array
name:
description: The name of the ramp.
type: string
number:
description: The number of the ramp. It is automaticcally generated by the billing system.
type: string
subscriptionNumber:
description: The number of the subscription that is considered as part of the ramp deal.
type: string
title: Ramp
type: object
OrderActionObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Order Action object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of an Order Action object.
'
title: orderActionFieldsCustom
type: object
Order:
description: Represents the order information that will be returned in the GET call.
properties:
category:
default: NewSales
description: 'Category of the order to indicate a product sale or return. Default value is `NewSales`.
'
enum:
- NewSales
- Return
type: string
createdBy:
description: The ID of the user who created this order.
type: string
createdDate:
description: The time that the order gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format.
format: datetime
type: string
currency:
description: Currency code.
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: The account number that this order has been created under. This is also the invoice owner of the subscriptions included in this order.
type: string
invoiceScheduleId:
description: 'The ID of the invoice schedule associated with the order.
**Note**: This field is available only if you have the Billing Schedule feature in the **Early Adopter** phase enabled.
'
type: integer
orderDate:
description: The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if no additinal contractEffectiveDate is provided.
format: date
type: string
orderLineItems:
description: "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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. \n\nWith 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. \n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
items:
$ref: '#/definitions/OrderLineItemRetrieveOrder'
type: array
orderNumber:
description: The order number of the order.
type: string
organizationLabel:
description: 'The organization that this object belongs to.
Note: This field is available only when the Multi-Org feature is enabled.
'
type: string
reasonCode:
description: 'Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.
'
maxLength: 255
type: string
schedulingOptions:
description: 'Information of scheduled order.
**Note**: The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.
'
properties:
scheduledDate:
description: 'The date for the order scheduled.
'
format: date
type: string
scheduledDatePolicy:
description: Date policy of the scheduled order.
enum:
- SpecificDate
type: string
type: object
status:
description: 'The status of the order. If the order contains any `Pending Activation` or `Pending Acceptance` subscription, the order status will be `Pending`; If the order is in draft status, the order status will be `Draft`; otherwise the order status is `Completed`.
The available order statuses are as follow:
- `Draft`: The order is in draft status.
- `Pending`: The order is in pending status.
- `Completed`: The order is in completed status.
- `Cancelled`: The draft or scheduled order is cancelled.
- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.
- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.
- `Failed`: The scheduled order has failed.
**Note**: The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.
'
enum:
- Draft
- Pending
- Completed
- Cancelled
- Scheduled
- Executing
- Failed
type: string
subscriptions:
description: Represents a processed subscription, including the origin request (order actions) that create this version of subscription and the processing result (order metrics). The reference part in the request will be overridden with the info in the new subscription version.
items:
properties:
baseVersion:
description: The base version of the subscription.
type: integer
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
externallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
newVersion:
description: The latest version of the subscription.
type: integer
orderActions:
items:
$ref: '#/definitions/OrderAction'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
ramp:
description: '**Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_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://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
The ramp definition.
'
items:
$ref: '#/definitions/RampResponse'
type: object
sequence:
description: The sequence number of a certain subscription processed by the order.
type: integer
subscriptionNumber:
description: The new subscription number for a new subscription created, or the existing subscription number. Unlike the order request, the subscription number here always has a value.
type: string
subscriptionOwnerAccountNumber:
description: The number of the account that owns the subscription.
type: string
type: object
type: array
updatedBy:
description: The ID of the user who updated this order.
type: string
updatedDate:
description: The time that the order gets updated in the system(for example, an order description update), in the `YYYY-MM-DD HH:MM:SS` format.
format: datetime
type: string
type: object
PricingUpdate:
properties:
chargeModelData:
allOf:
- $ref: '#/definitions/ChargeModelDataOverride'
description: 'Container for charge model configuration data.
**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
'
discount:
allOf:
- $ref: '#/definitions/DiscountPricingUpdate'
description: 'Pricing information about a discount charge.
'
recurringDelivery:
allOf:
- $ref: '#/definitions/RecurringDeliveryPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "delivery" charge model. This field is only available if you have the Delivery Pricing charge model enabled.
**Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**.
'
recurringFlatFee:
allOf:
- $ref: '#/definitions/RecurringFlatFeePricingUpdate'
description: 'Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
recurringPerUnit:
allOf:
- $ref: '#/definitions/RecurringPerUnitPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
'
recurringTiered:
allOf:
- $ref: '#/definitions/RecurringTieredPricingUpdate'
description: 'Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.
'
recurringVolume:
allOf:
- $ref: '#/definitions/RecurringVolumePricingUpdate'
description: 'Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.
'
usageFlatFee:
allOf:
- $ref: '#/definitions/UsageFlatFeePricingUpdate'
description: 'Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
usageOverage:
allOf:
- $ref: '#/definitions/UsageOveragePricingUpdate'
description: 'Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.
'
usagePerUnit:
allOf:
- $ref: '#/definitions/UsagePerUnitPricingUpdate'
description: 'Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed.
'
usageTiered:
allOf:
- $ref: '#/definitions/UsageTieredPricingUpdate'
description: 'Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.
'
usageTieredWithOverage:
allOf:
- $ref: '#/definitions/UsageTieredWithOveragePricingUpdate'
description: 'Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.
'
usageVolume:
allOf:
- $ref: '#/definitions/UsageVolumePricingUpdate'
description: 'Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.
'
type: object
GetOrderResponse:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
order:
$ref: '#/definitions/Order'
type: object
OrderLineItemCommonPostOrder:
properties:
UOM:
description: 'Specifies the units to measure usage.
'
type: string
accountingCode:
description: 'The accounting code for the Order Line Item.
'
type: string
adjustmentLiabilityAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
adjustmentRevenueAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
amountPerUnit:
description: 'The actual charged amount per unit for the Order Line Item.
If you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.
'
type: number
billTargetDate:
description: 'The target date for the Order Line Item to be picked up by bill run for billing.
'
format: date
type: string
billTo:
description: 'The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.
'
type: string
billingRule:
default: TriggerWithoutFulfillment
description: 'The billing rule for the Order Line Item.
'
enum:
- TriggerWithoutFulfillment
- TriggerAsFulfillmentOccurs
type: string
contractAssetAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
contractLiabilityAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
contractRecognizedRevenueAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
customFields:
$ref: '#/definitions/OrderLineItemCustomFields'
deferredRevenueAccountingCode:
description: 'The deferred revenue accounting code for the Order Line Item.
'
type: string
description:
description: 'The description of the Order Line Item.
'
type: string
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: 'The flag to exclude Order Line Item from revenue accounting.
**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.
'
type: boolean
inlineDiscountPerUnit:
description: 'Use this field in accordance with the `inlineDiscountType` field, in the following manner:
* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.
* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.
Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.
'
type: number
inlineDiscountType:
description: "Use this field to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nUse this field together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
enum:
- Percentage
- FixedAmount
- None
type: string
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
itemCategory:
default: Sales
description: 'The category for the Order Line Item, to indicate a product sale or return.
'
enum:
- Sales
- Return
type: string
itemName:
description: 'The name of the Order Line Item.
'
type: string
itemNumber:
description: 'The number of the Order Line Item. Use this field to specify a custom item number for your Order Line Item. If you are to use this field, you must set all the item numbers in an order when there are several order line items in the order.
'
type: string
itemState:
description: 'The state of an Order Line Item. If you want to generate billing documents for order line items, you must set this field to `SentToBilling`. For invoice preview, you do not need to set this field.
See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.
'
enum:
- Executing
- Booked
- SentToBilling
- Complete
- Cancelled
type: string
itemType:
description: "The type of the Order Line Item. \n"
enum:
- Product
- Fee
- Services
type: string
listPricePerUnit:
description: 'The list price per unit for the Order Line Item.
'
type: number
originalOrderLineItemNumber:
description: "The number of the original sale order line item for a return order line item. \n"
type: string
originalOrderNumber:
description: "The number of the original sale order for a return order line item. \n"
type: string
ownerAccountNumber:
description: 'Use this field to assign an existing account as the owner of an order line item.
'
type: string
productCode:
description: 'The product code for the Order Line Item.
'
type: string
productRatePlanChargeId:
description: 'Id of a Product Rate Plan Charge. Only one-time charges are supported.
'
type: string
purchaseOrderNumber:
description: 'Used by customers to specify the Purchase Order Number provided by the buyer.
'
type: string
quantity:
description: 'The quantity of units, such as the number of authors in a hosted wiki service.
'
type: number
recognizedRevenueAccountingCode:
description: 'The recognized revenue accounting code for the Order Line Item.
'
type: string
relatedSubscriptionNumber:
description: 'Use this field to relate an order line item to a subscription when you create the order line item.
* To relate an order line item to a new subscription which is yet to create in the same "Create an order" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the "Create an order" operation. Specify this field to the same value as that of the `subscriptions` > `subscriptionNumber` field when you make the "Create an order" call.
* To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.
'
type: string
revenueRecognitionRule:
description: 'The Revenue Recognition rule for the Order Line Item.
'
type: string
sequenceSetId:
description: 'The ID of the sequence set associated with the OrderLineItem.
'
type: string
soldTo:
description: "Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules:\n\n* If the `ownerAccountNumber` field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item. \n* If the `ownerAccountNumber` field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item.\n"
type: string
taxCode:
description: 'The tax code for the Order Line Item.
'
type: string
taxMode:
description: 'The tax mode for the Order Line Item.
'
enum:
- TaxInclusive
- TaxExclusive
type: string
transactionEndDate:
description: 'The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.
'
format: date
type: string
transactionStartDate:
description: 'The date a transaction starts. The default value of this field is the order date.
'
format: date
type: string
unbilledReceivablesAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
title: OrderLineItem
type: object
CreatePaymentMethodGooglePayAdyenChase:
properties:
googlePaymentToken:
description: 'This field is specific for setting up Google Pay for Adyen and Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) and [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase).
'
type: string
type: object
RampIntervalRequest:
description: 'Container for the intervals that the ramp is split into in its timeline. Zuora can report metrics for this specific period.
'
properties:
description:
description: The short description of the interval.
type: string
endDate:
description: The end date of the interval.
format: date
type: string
name:
description: The name of the interval.
type: string
startDate:
description: The start date of the interval.
format: date
type: string
required:
- startDate
- endDate
title: intervals
type: object
PUTOrderActionTriggerDatesRequestType:
example:
subscriptions:
- orderActions:
- charges:
- chargeNumber: C-0000001
specificTriggerDate: '2016-09-01'
sequence: 0
triggerDates:
- name: CustomerAcceptance
triggerDate: '2016-09-01'
subscriptionNumber: A-S00000009
properties:
subscriptions:
items:
properties:
orderActions:
items:
properties:
charges:
items:
properties:
chargeNumber:
description: Charge number of the charge which needs the triggering date to be provided. The charge's `triggerEvent` must have been set as `SpecificDate`.
type: string
specificTriggerDate:
description: Date in YYYY-MM-DD format. The specific trigger date you are to set for the charge.
format: date
type: string
type: object
type: array
sequence:
description: "Identifies which order action will have its triggering dates updated. \n"
type: integer
triggerDates:
description: Container for the service activation and customer acceptance dates of the order action.
items:
properties:
name:
description: Name of the trigger date of the order action.
enum:
- ServiceActivation
- CustomerAcceptance
type: string
triggerDate:
description: 'Trigger date in YYYY-MM-DD format. The date you are to set as the service activation date or the customer acceptance date.
'
format: date
type: string
type: object
type: array
required:
- sequence
type: object
type: array
subscriptionNumber:
description: 'Subscription number of a subscription in the `Pending` order for which you are to update the triggering dates. For example, A-S00000001.
'
maxLength: 100
type: string
required:
- subscriptionNumber
type: object
type: array
type: object
RecurringPerUnitPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Per-unit price of the charge in each recurring period.
'
type: number
listPriceBase:
description: 'Specifies the duration of each recurring period.
'
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
priceIntervals:
description: "List of interval pricing in the charge. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
items:
$ref: '#/definitions/PriceIntervalWithPrice'
type: array
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
specificListPriceBase:
description: "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the Annual List Price feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
format: int32
maximum: 200
minimum: 1
type: integer
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
type: object
description: 'Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
'
title: recurringPerUnit
CreateOrderCreateSubscription:
description: 'Information about an order action of type `CreateSubscription`.
'
properties:
billToContactId:
description: "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
currency:
description: "The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.\n\nAll subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.\n\n**Note**: \n This field is available only if you have the Multiple Currencies feature enabled.\n"
maxLength: 3
type: string
invoiceSeparately:
description: 'Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.
'
type: boolean
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
newSubscriptionOwnerAccount:
$ref: '#/definitions/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount'
notes:
description: 'Notes about the subscription. These notes are only visible to Zuora users.
'
maxLength: 500
type: string
paymentTerm:
description: "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
subscribeToProducts:
description: "List of offers or rate plans associated with the subscription. \n- For a rate plans, the following fields are available:\n - `chargeOverrides`\n - `clearingExistingFeatures`\n - `customFields`\n - `externalCatalogPlanId`\n - `externallyManagedPlanId`\n - `productRatePlanId`\n - `subscriptionProductFeatures`\n - `uniqueToken`\n- For an offer, the following fields are available:\n - `customFields`\n - `productOfferId`\n - `productOfferNumber`\n - `ratePlanOverrides`\n - `subscriptionOfferUniqueToken`\n"
items:
$ref: '#/definitions/CreateSubscribeToProduct'
type: array
subscribeToRatePlans:
description: 'List of rate plans associated with the subscription.
**Note**: The `subscribeToRatePlans` field has been deprecated, this field is replaced by the `subscribeToProducts` field that supports both Rate Plans and Offers. In a new order request, you can use either `subscribeToRatePlans` or `subscribeToProducts`, not both.
'
items:
$ref: '#/definitions/CreateOrderRatePlanOverride'
type: array
subscriptionNumber:
description: 'Subscription number of the subscription. For example, A-S00000001.
If you do not set this field, Zuora will generate the subscription number.
'
maxLength: 100
type: string
subscriptionOwnerAccountNumber:
description: 'Account number of an existing account that will own the subscription. For example, A00000001.
If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.
'
maxLength: 70
type: string
terms:
description: 'Container for the terms and renewal settings of the subscription.
'
properties:
autoRenew:
description: 'Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.
'
type: boolean
initialTerm:
description: 'Information about the first term of the subscription.
'
properties:
period:
description: 'Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.
'
type: integer
periodType:
description: 'Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.
'
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'Start date of the first term, in YYYY-MM-DD format.
'
format: date
type: string
termType:
description: 'Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.
'
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
renewalSetting:
description: 'Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.
* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.
* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.
'
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
description: 'List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
'
items:
$ref: '#/definitions/RenewalTerm'
type: array
required:
- initialTerm
type: object
title: createSubscription
type: object
CreatePaymentMethodPayPalAdaptive:
properties:
preapprovalKey:
description: 'The PayPal preapproval key.
'
type: string
type: object
RecurringTieredPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
quantity:
minimum: 0
type: number
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
ChargeOverride:
description: 'Charge associated with a rate plan.
'
properties:
accountReceivableAccountingCode:
description: 'The accountReceivableAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.
'
type: string
adjustmentLiabilityAccountingCode:
description: 'The adjustmentLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
adjustmentRevenueAccountingCode:
description: 'The adjustmentRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
billing:
description: 'Billing information about the charge.
'
properties:
billCycleDay:
description: 'Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.
'
maximum: 31
minimum: 0
type: integer
billCycleType:
description: "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
enum:
- DefaultFromCustomer
- SpecificDayofMonth
- SubscriptionStartDay
- ChargeTriggerDay
- SpecificDayofWeek
type: string
billingPeriod:
description: 'Billing frequency of the charge. The value of this field controls the duration of each billing period.
If the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.
'
enum:
- Month
- Quarter
- Semi_Annual
- Annual
- Eighteen_Months
- Two_Years
- Three_Years
- Five_Years
- Specific_Months
- Subscription_Term
- Week
- Specific_Weeks
type: string
billingPeriodAlignment:
description: 'Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.
* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.
* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.
* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.
See the `billCycleType` field for information about how Zuora determines the billing day.
'
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
billingTiming:
description: 'Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).
'
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
specificBillingPeriod:
description: 'Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.
'
type: integer
weeklyBillCycleDay:
description: 'Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.
'
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
type: object
chargeModel:
description: 'The chargeModel of a standalone charge.
Supported charge models:
* `FlatFee`
* `PerUnit`
* `Volume`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
chargeNumber:
description: 'Charge number of the charge. For example, C-00000307.
If you do not set this field, Zuora will generate the charge number.
'
maxLength: 50
type: string
chargeType:
description: 'The chargeType of a standalone charge.
Supported charge types:
* `OneTime`
* `Recurring`
* `Usage`
* `DiscountFixedAmount`
* `DiscountPercentage`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
contractAssetAccountingCode:
description: 'The contractAssetAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractLiabilityAccountingCode:
description: 'The contractLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractRecognizedRevenueAccountingCode:
description: 'The contractRecognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
deferredRevenueAccountingCode:
description: 'The deferredRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
description:
description: 'Description of the charge.
'
maxLength: 500
type: string
drawdownRate:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).
'
type: number
endDate:
$ref: '#/definitions/EndConditions'
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in an Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isRollover:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The value is either "True" or "False". It determines whether the rollover fields are needed.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
name:
description: 'The name of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
pobPolicy:
description: 'The pobPolicy of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
prepaidQuantity:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).
'
type: number
pricing:
description: 'Pricing information about the charge.
'
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingOverride'
oneTimeFlatFee:
$ref: '#/definitions/OneTimeFlatFeePricingOverride'
oneTimePerUnit:
$ref: '#/definitions/OneTimePerUnitPricingOverride'
oneTimeTiered:
$ref: '#/definitions/OneTimeTieredPricingOverride'
oneTimeVolume:
$ref: '#/definitions/OneTimeVolumePricingOverride'
recurringDelivery:
$ref: '#/definitions/RecurringDeliveryPricingOverride'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingOverride'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingOverride'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingOverride'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingOverride'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingOverride'
usageOverage:
$ref: '#/definitions/UsageOveragePricingOverride'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingOverride'
usageTiered:
$ref: '#/definitions/UsageTieredPricingOverride'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingOverride'
usageVolume:
$ref: '#/definitions/UsageVolumePricingOverride'
type: object
productCategory:
description: 'The productCategory of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productClass:
description: 'The productClass of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productFamily:
description: 'The productFamily of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productLine:
description: 'The productLine of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productRatePlanChargeNumber:
description: 'Number of a product rate-plan charge for this subscription.
'
type: string
productRateplanChargeId:
description: 'Internal identifier of the product rate plan charge that the charge is based on.
'
type: string
recognizedRevenueAccountingCode:
description: 'The recognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
revRecCode:
description: 'Revenue Recognition Code
'
maxLength: 70
type: string
revRecTriggerCondition:
description: "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
enum:
- Contract Effective Date
- Service Activation Date
- Customer Acceptance Date
type: string
revenueRecognitionRuleName:
description: 'Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.
'
type: string
rolloverApply:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the priority of rollover, which is either first or last.
'
enum:
- ApplyFirst
- ApplyLast
type: string
rolloverPeriodLength:
default: null
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period length of the rollover fund.
'
type: integer
rolloverPeriods:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the number of rollover periods, it is restricted to 3.
'
type: number
startDate:
$ref: '#/definitions/TriggerParams'
taxCode:
description: 'The taxCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
taxMode:
description: "The taxMode of a standalone charge. \n\nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"
type: string
unBilledReceivablesAccountingCode:
description: 'The unBilledReceivablesAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
uniqueToken:
description: 'Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
'
maxLength: 50
type: string
validityPeriodType:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
'
enum:
- SUBSCRIPTION_TERM
- ANNUAL
- SEMI_ANNUAL
- QUARTER
- MONTH
type: string
required:
- productRateplanChargeId
title: charge
type: object
ChangePlanRatePlanOverride:
description: "Information about the new product rate plan to add. \n"
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/ChangePlanChargeOverride'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/RatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
title: ratePlan
type: object
RatePlanChargeObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Rate Plan Charge object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Rate Plan Charge object.
'
title: ratePlanChargeFieldsCustom
type: object
UsageOveragePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
includedUnits:
description: 'A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed.
'
type: number
overagePrice:
type: number
type: object
TaxInfo:
description: 'Information about the tax exempt status of a customer account.
'
properties:
VATId:
description: 'EU Value Added Tax ID.
**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).
'
maxLength: 25
type: string
companyCode:
description: 'Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.
**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).
'
maxLength: 50
type: string
exemptCertificateId:
description: 'ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.
'
maxLength: 32
type: string
exemptCertificateType:
description: 'Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.
'
maxLength: 32
type: string
exemptDescription:
description: 'Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.
'
maxLength: 500
type: string
exemptEffectiveDate:
description: 'Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.
'
format: date
type: string
exemptExpirationDate:
description: 'Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.
'
format: date
type: string
exemptIssuingJurisdiction:
description: 'Jurisdiction in which the customer tax exemption certificate was issued.
'
maxLength: 32
type: string
exemptStatus:
default: 'No'
description: "Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n"
enum:
- 'No'
- 'Yes'
- PendingVerification
type: string
title: taxInfo
type: object
RenewSubscription:
description: 'Information about an order action of type `RenewSubscription`.
'
properties:
billToContactId:
description: "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
clearingExistingBillToContact:
default: false
description: 'Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: 'Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingPaymentTerm:
default: false
description: 'Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSequenceSet:
default: false
description: 'Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSoldToContact:
default: false
description: 'Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
paymentTerm:
description: "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body..\n"
type: string
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n \n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
title: RenewSubscription
type: object
RampIntervalChargeMetrics:
properties:
chargeNumber:
description: The number of the charge.
type: string
discountTcb:
description: The discount amount for the TCB.
type: number
discountTcv:
description: The discount amount for the TCV.
type: number
endDate:
description: The end date of the rate plan charge in the current ramp interval.
format: date
type: string
grossTcb:
description: The gross TCB value before discount charges are applied.
type: number
grossTcv:
description: The gross TCV value before discount charges are applied.
type: number
mrr:
description: The MRR changing history of the current rate plan charge in the current ramp interval.
items:
properties:
discount:
description: The discount amount for the MRR.
type: number
endDate:
description: The end date.
format: date
type: string
gross:
description: The gross MRR amount before discounts charges are applied.
type: number
net:
description: The net MRR amount after discounts charges are applied.
type: number
startDate:
description: The start date.
format: date
type: string
type: object
type: array
netTcb:
description: The net TCB value after discount charges are applied.
type: number
netTcv:
description: The net TCV value after discount charges are applied.
type: number
productRatePlanChargeId:
description: The ID of the corresponding product rate plan charge.
type: string
quantity:
description: The quantity of the rate plan charge.
type: number
ratePlanChargeId:
description: The ID of the rate plan charge.
type: string
startDate:
description: The start date of the rate plan charge in the current ramp interval.
format: date
type: string
subscriptionNumber:
description: The number of the subscription that the current rate plan charge belongs to.
type: string
title: intervalMetrics
type: object
CommonResponseType:
properties:
processId:
description: 'The Id of the process that handle the operation.
'
type: string
reasons:
items:
properties:
code:
description: 'The error code of response.
'
type: string
message:
description: 'The detail information of the error response
'
type: string
type: object
type: array
success:
description: 'Indicates whether the call succeeded.
'
type: boolean
type: object
DataAccessControlField:
additionalProperties:
description: 'Field for data access control. The name of the data access control field has the form *customField*__h. The data access control field is case sensitive. See [Data Access Control](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/Data_Access_Control) for more information.
'
type: string
description: 'Container for the data access control field.
'
title: dataAccessControlField
type: object
ChargeTier:
properties:
endingUnit:
description: 'Limit on the number of units for which the tier is effective.
'
type: number
price:
description: 'Price or per-unit price of the tier, depending on the value of the `priceFormat` field.
'
type: number
priceFormat:
description: 'Specifies whether the tier has a fixed price or a per-unit price.
'
enum:
- FlatFee
- PerUnit
type: string
startingUnit:
description: 'Number of units at which the tier becomes effective.
'
type: number
tier:
description: 'Index of the tier in the charge.
'
minimum: 1
type: integer
required:
- tier
- startingUnit
- price
- priceFormat
title: chargeTier
type: object
RecurringFlatFeePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
type: object
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccountPaymentMethod:
allOf:
- properties:
type:
description: 'Type of payment method. The following types of the payment method are supported:
* `CreditCard` - Credit card payment method.
* `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.
* `ACH` - ACH payment method.
* `SEPA` - Single Euro Payments Area.
* `Betalingsservice` - Direct Debit DK.
* `Autogiro` - Direct Debit SE.
* `Bacs` - Direct Debit UK.
* `Becs` - Direct Entry AU.
* `Becsnz` - Direct Debit NZ.
* `PAD` - Pre-Authorized Debit.
* `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.
* `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.
* `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.
* `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.
* `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details.
* `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details.
* `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details.
* You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.
'
type: string
required:
- type
type: object
- $ref: '#/definitions/CreatePMPayPalECPayPalNativeECPayPalCP'
- $ref: '#/definitions/CreatePaymentMethodPayPalAdaptive'
- $ref: '#/definitions/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccountPaymentMethodCreditCard'
- $ref: '#/definitions/CreatePaymentMethodACH'
- $ref: '#/definitions/CreatePaymentMethodCommon'
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
- $ref: '#/definitions/CreatePaymentMethodBankTransfer'
- $ref: '#/definitions/CreatePaymentMethodCCReferenceTransaction'
- $ref: '#/definitions/CreatePaymentMethodApplePayAdyen'
- $ref: '#/definitions/CreatePaymentMethodGooglePayAdyenChase'
description: 'Payment method to create for this new account. Supports all the payment methods that are supported in the "Create a payment method" operation. See [Create a payment method](/api-references/api/operation/POST_PaymentMethods) for more information.
'
ChargePreviewMetrics:
properties:
chargeNumber:
type: string
cmrr:
properties:
discount:
description: 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".
type: number
discountDelta:
description: Delta discountCmrr value between the order base and the latest subscription version.
type: number
regular:
type: number
regularDelta:
type: number
type: object
originRatePlanId:
type: string
productRatePlanChargeId:
type: string
productRatePlanId:
type: string
tax:
properties:
discount:
description: 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.
type: number
discountDelta:
description: Delta discount TAX value between the base and the latest subscription version in the order for the specific recurring charge.
type: number
regular:
type: number
regularDelta:
description: Delta tax value between the base and the latest subscription version in the order.
type: number
type: object
tcb:
properties:
discount:
description: 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.
type: number
discountDelta:
description: Delta discount TCB value between the base and the latest subscription version for specific recurring charge in the order.
type: number
regular:
type: number
regularDelta:
description: Delta TCB value between the base and the latest subscription version in the order.
type: number
type: object
tcv:
properties:
discount:
description: Always equals to discountTcb.
type: number
discountDelta:
description: Always equals to delta discountTcb.
type: number
regular:
type: number
regularDelta:
type: number
type: object
type: object
ContactObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Contact object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Contact object.
'
title: contactFieldsCustom
type: object
OrderRampIntervalMetrics:
properties:
description:
description: The short description of the interval.
type: string
discountTcb:
description: The discount amount for the TCB.
type: number
discountTcv:
description: The discount amount for the TCV.
type: number
endDate:
description: The end date of the interval.
format: date
type: string
grossTcb:
description: The gross TCB value before discount charges are applied.
type: number
grossTcv:
description: The gross TCV value before discount charges are applied.
type: number
intervalDeltaMetrics:
description: 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.
items:
$ref: '#/definitions/RampIntervalChargeDeltaMetrics'
type: array
intervalMetrics:
description: Container for the detailed metrics for each rate plan charge in each ramp interval.
items:
$ref: '#/definitions/RampIntervalChargeMetrics'
type: array
name:
description: The name of the interval.
type: string
netTcb:
description: The net TCB value after discount charges are applied.
type: number
netTcv:
description: The net TCV value after discount charges are applied.
type: number
startDate:
description: The start date of the interval.
format: date
type: string
title: RampIntervalMetrics
type: object
CreatePaymentMethodCardholderInfo:
description: 'Container for cardholder information. This container field is required for credit card payment methods. The nested `cardHolderName` field is required.
'
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
cardHolderName:
description: 'The card holder''s full name as it appears on the card, e.g., "John J Smith", 50 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
'
type: string
country:
description: 'Country, must be a valid country name or abbreviation.
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
'
type: string
email:
description: 'Card holder''s email address, 80 characters or less.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State; must be a valid state name or 2-character abbreviation.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- cardHolderName
title: cardHolderInfo
type: object
CreatePaymentMethodCreditCard:
properties:
cardHolderInfo:
$ref: '#/definitions/CreatePaymentMethodCardholderInfo'
cardNumber:
description: 'Credit card number. This field is required if `type` is set to `CreditCard`.
'
type: string
cardType:
description: 'The type of the credit card. This field is required if `type` is set to `CreditCard`.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
'
type: string
checkDuplicated:
description: "Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.\n\nWith this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.\n \nThe following fields are used for the duplication check:\n - `cardHolderName`\n - `expirationMonth`\n - `expirationYear`\n - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example:\n ```\n ************1234\n ```\n"
type: boolean
expirationMonth:
description: 'One or two digit expiration month (1-12) of the credit card. This field is required if `type` is set to `CreditCard`.
'
type: integer
expirationYear:
description: 'Four-digit expiration year of the credit card. This field is required if `type` is set to `CreditCard`.
'
type: integer
mitConsentAgreementRef:
description: 'Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.
'
maxLength: 128
type: string
mitConsentAgreementSrc:
description: 'Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
'
enum:
- External
type: string
mitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
mitProfileAction:
description: "Specifies how Zuora creates and activates the stored credential profile.\n\n- `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n\n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n\n\n- `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n\nIf you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n"
enum:
- Activate
- Persist
type: string
mitProfileAgreedOn:
description: 'The date on which the profile is agreed. The date format is `yyyy-mm-dd`.
'
format: date
type: string
mitProfileType:
description: 'Required if you set the `mitProfileAction` field. Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
'
enum:
- Recurring
- Unscheduled
type: string
screeningAmount:
description: 'For Chase Paymentech Orbital Gateway integrations, if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions.
Two-decimal amount is supported.
If the `screeningAmount` field is not specified, the authorization amount is used for fraud screening.
'
format: decimal
type: number
securityCode:
description: 'CVV or CVV2 security code of the credit card.
To ensure PCI compliance, this value is not stored and cannot be queried.
'
type: string
type: object
OneTimePerUnitPricingOverride:
description: 'Pricing information about a one-time charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
'
properties:
listPrice:
description: 'Per-unit price of the charge.
'
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
title: oneTimePerUnit
type: object
QuoteObjectFields:
description: 'The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote.
'
properties:
OpportunityCloseDate__QT:
description: 'The closing date of the Opportunity.
This field is used in Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
'
type: string
OpportunityName__QT:
description: "The unique identifier of the Opportunity. \n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 100\n"
type: string
QuoteBusinessType__QT:
description: 'The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn.
This field is used in the Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
**Character limit**: 32
'
type: string
QuoteNumber__QT:
description: 'The unique identifier of the Quote.
This field is used in the Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
**Character limit**: 32
'
type: string
QuoteType__QT:
description: 'The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel.
This field is used in the Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
**Character limit**: 32
'
type: string
title: quote
type: object
OwnerTransfer:
description: 'Information about an order action of type `OwnerTransfer`.
**Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
'
properties:
billToContactId:
description: "The contact id of the bill to contact that the subscription is being transferred to.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
clearingExistingBillToContact:
default: false
description: 'Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: 'Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingPaymentTerm:
default: false
description: 'Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSequenceSet:
default: false
description: 'Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSoldToContact:
default: false
description: 'Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
destinationAccountNumber:
description: 'The account number of the account that the subscription is being transferred to.
'
type: string
destinationInvoiceAccountNumber:
description: 'The account number of the invoice owner account that the subscription is being transferred to.
'
type: string
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
paymentTerm:
description: "Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
title: ownerTransfer
type: object
PaymentMethodObjectCustomFields:
additionalProperties:
description: 'Custom fields of the payment method. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a payment method object.
'
title: paymentMethodFieldsCustom
type: object
GetOrderResume:
description: 'Information about an order action of type `Resume`.
'
properties:
extendsTerm:
description: 'Specifies whether to extend the subscription term by the length of time the suspension is in effect. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.
'
type: boolean
resumeDate:
description: 'The resume date when the resumption takes effect.
'
format: date
type: string
resumePeriods:
description: "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriodsType` field. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nThe total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
type: integer
resumePeriodsType:
description: "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriods` field. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nThe period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
enum:
- Day
- Week
- Month
- Year
type: string
resumePolicy:
description: "Resume methods. Specify a way to resume a subscription. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nIf `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. \n"
enum:
- Today
- FixedPeriodsFromSuspendDate
- FixedPeriodsFromToday
- SpecificDate
- SuspendDate
type: string
resumeSpecificDate:
description: 'This field is applicable only when the `resumePolicy` field is set to `SpecificDate`. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.
A specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.
'
format: date
type: string
title: Resume
type: object
UsageTieredPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
EndConditions:
description: 'Specifies when a charge becomes inactive.
'
properties:
endDateCondition:
description: 'Condition for the charge to become inactive.
- If the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.
- If the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when the charge becomes inactive.
'
enum:
- Subscription_End
- Fixed_Period
- Specific_End_Date
type: string
endDatePolicy:
description: "End date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation. \n\n- If the value of this field is `FixedPeriod`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n- If the value of this field is `SpecificEndDate`, use the `specificEndDate` field to specify the date when the charge becomes inactive.\n\n**Notes**: \n- You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n- You can use either `endDateCondition` or `endDatePolicy` to define when a discount charge ends, but not both at the same time.\n"
enum:
- AlignToApplyToCharge
- SpecificEndDate
- FixedPeriod
type: string
specificEndDate:
description: 'Date in YYYY-MM-DD format. Only applicable if the value of the `endDateCondition` field is `Specific_End_Date`.
'
format: date
type: string
upToPeriods:
description: 'Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the `upToPeriodsType` field. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`.
'
type: integer
upToPeriodsType:
description: 'Unit of time that the charge duration is measured in. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`.
'
enum:
- Billing_Periods
- Days
- Weeks
- Months
- Years
type: string
title: endDate
type: object
UsageVolumePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
AccountCreditCardHolder:
description: 'Information about the cardholder of a credit card payment method associated with an account. If you do not provide information about the cardholder, Zuora uses the account''s bill-to contact.
'
properties:
addressLine1:
description: 'First line of the cardholder''s address.
'
maxLength: 255
type: string
addressLine2:
description: 'Second line of the cardholder''s address.
'
maxLength: 255
type: string
cardHolderName:
description: 'Full name of the cardholder as it appears on the card. For example, "John J Smith".
'
maxLength: 50
type: string
city:
description: 'City of the cardholder''s address.
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
'
maxLength: 40
type: string
country:
description: 'Country of the cardholder''s address. The value of this field must be a valid country name or abbreviation.
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
'
maxLength: 64
type: string
email:
description: 'Email address of the cardholder.
'
maxLength: 80
type: string
phone:
description: 'Phone number of the cardholder.
'
maxLength: 40
type: string
state:
description: 'State or province of the cardholder''s address.
'
maxLength: 50
type: string
zipCode:
description: 'ZIP code or other postal code of the cardholder''s address.
'
maxLength: 20
type: string
type: object
UsageTieredWithOveragePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
overagePrice:
type: number
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
PUTOrderTriggerDatesResponseType:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
accountNumber:
description: The account number for the order.
type: string
orderNumber:
description: The order number of the order updated.
type: string
status:
description: Status of the order.
enum:
- Completed
- Pending
type: string
subscriptions:
description: The subscriptions updated.
items:
properties:
status:
description: Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action.
enum:
- Active
- Pending Activation
- Pending Acceptance
type: string
subscriptionNumber:
description: Subscription number of the subscription updated.
type: string
type: object
type: array
type: object
OrderLineItemCustomFields:
additionalProperties:
description: 'Custom fields of the Order Line Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of an Order Line Item object.
'
title: OrderLineItemCustomFields
type: object
OneTimeVolumePricingOverride:
description: 'Pricing information about a one-time charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.
'
properties:
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
tiers:
description: 'List of variable pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
title: oneTimeVolume
type: object
RatePlanOverride:
description: 'Rate plan associated with a subscription.
'
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/ChargeOverride'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
isFromExternalCatalog:
description: 'Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: boolean
newRatePlanId:
description: 'Internal identifier of the rate plan.
'
type: string
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanName:
description: 'Name of the standalone rate plan.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
subscriptionProductFeatures:
description: "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. \n"
items:
$ref: '#/definitions/RatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
required:
- productRatePlanId
title: ratePlan
type: object
orderMetric:
description: The set of order metrics for an order action.
properties:
chargeNumber:
type: string
elp:
description: "The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity.\n\nThe `elp` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
items:
$ref: '#/definitions/TimeSlicedElpNetMetrics'
type: array
mrr:
items:
$ref: '#/definitions/TimeSlicedNetMetrics'
type: array
originRatePlanId:
type: string
productRatePlanChargeId:
type: string
productRatePlanId:
type: string
quantity:
items:
$ref: '#/definitions/TimeSlicedMetrics'
type: array
tcb:
description: Total contracted billing which is the forecast value for the total invoice amount.
items:
$ref: '#/definitions/TimeSlicedTcbNetMetrics'
type: array
tcv:
description: Total contracted value.
items:
$ref: '#/definitions/TimeSlicedNetMetrics'
type: array
type: object
POSTOrderRequestType:
example:
description: This is a description for the Order.
existingAccountNumber: A00000001
orderDate: '2017-01-01'
orderLineItems:
- billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billingTrigger: BillImmediately
chargeAmountPerUnit: 50
customFields:
someField__c: some string
deferredRevenueAccountingCode: Unearned Revenues
description: With Dual Stereo Microphones, HD 1080p, Black
itemName: webcam
itemType: Product
listPricePerUnit: 59
ownerAccountNumber: AN_1683614809986
productCode: C9201
purchaseOrderNumber: 960-000764
quantity: 2
recognizedRevenueAccountingCode: Earned Revenues
revenueRecognitionRule: recognized upon invoice
soldTo: 4028fc828244a0ac018244dfc9a90bee
taxCode: '8018'
taxMode: TaxInclusive
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
orderNumber: OM-00001
processingOptions:
applyCreditBalance: true
billingOptions:
creditMemoReasonCode: Unsatisfactory service
targetDate: '2017-08-01'
collectPayment: true
electronicPaymentOptions:
authTransactionId: pi_3OER45dashnqYj
gatewayOrderId: A001
paymentGatewayId: 2c9890186cb7c157016cd18c72370999
paymentMethodId: 2c9890186cb7c157016cd18c6f690999
runBilling: true
subscriptions:
- orderActions:
- createSubscription:
billToContactId: efbff07e6290dfb8016291003bd00dda
invoiceTemplateId: 2c9081a03c638994013c63978baf002b
paymentTerm: Net 30
sequenceSetId: 6abcc30846de11e990900242ac1f0003
soldToContactId: efbff07e6290dfb8016291003bd00ddb
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb8016291003bd00dda
subscriptionNumber: SM-00001
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb8016291003bd00dda
subscriptionNumber: SM-00002
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-02-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-02-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- productRatePlanId: efbff07e6290dfb80162910024c80dd5
subscriptionNumber: SM-00003
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-04-01'
type: CreateSubscription
- orderActions:
- createSubscription:
subscribeToRatePlans:
- chargeOverrides:
- productRatePlanChargeId: efbff07e6290dfb80162910024d80dd7
startDate:
triggerEvent: SpecificDate
productRatePlanId: efbff07e6290dfb80162910024c80dd5
uniqueToken: Sugar-free Monthly
subscriptionNumber: SM-00004
terms:
autoRenew: true
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 12
periodType: Month
triggerDates:
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-04-01'
type: CreateSubscription
- orderActions:
- suspend:
suspendPeriods: 2
suspendPeriodsType: Week
suspendPolicy: FixedPeriodsFromToday
triggerDates:
- name: ContractEffective
triggerDate: '2018-01-01'
- name: ServiceActivation
triggerDate: '2018-01-01'
- name: CustomerAcceptance
triggerDate: '2018-01-01'
type: Suspend
subscriptionNumber: SM-00005
- orderActions:
- resume:
extendsTerm: true
resumePolicy: SpecificDate
resumeSpecificDate: '2018-10-01'
triggerDates:
- name: ContractEffective
triggerDate: '2018-01-01'
- name: ServiceActivation
triggerDate: '2018-01-01'
- name: CustomerAcceptance
triggerDate: '2018-01-01'
type: Resume
subscriptionNumber: SM-00006
properties:
category:
default: NewSales
description: 'Category of the order to indicate a product sale or return. Default value is `NewSales`.
'
enum:
- NewSales
- Return
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: "The account number that this order will be created under. \n\nNote that this actually specifies the invoice owner account of the subscriptions included in this order.\n"
maxLength: 70
type: string
externallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
newAccount:
$ref: '#/definitions/Account'
orderDate:
description: The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null.
format: date
type: string
orderLineItems:
description: "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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. \n\nWith 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.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
items:
$ref: '#/definitions/CreateOrderOrderLineItem'
type: array
orderNumber:
description: "The order number of the new order. If not provided, system will auto-generate a number for this order. \n**Note:** Make sure the order number does not contain a slash. \n"
maxLength: 100
type: string
processingOptions:
$ref: '#/definitions/processingOptionsOrdersWithDelayedCapturePayment'
reasonCode:
description: 'Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.
'
maxLength: 255
type: string
schedulingOptions:
description: "Information of scheduled order. \n\n**Note**: The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.\n"
properties:
scheduledDate:
description: 'The date for the order scheduled.
'
format: date
type: string
scheduledDatePolicy:
description: Date policy of the scheduled order.
enum:
- SpecificDate
type: string
type: object
status:
description: 'The status of the order. The default value is `Completed`. The following values are supported:
- `Draft`: The order is in draft status.
- `Pending`: The order is in pending status.
- `Completed`: The order is in completed status.
- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.
- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.
- `Failed`: The scheduled order has failed.
**Note**: The Scheduled Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access features from the self-service interface, see Enable billing features by yourself.
'
enum:
- Draft
- Pending
- Completed
- Scheduled
- Executing
- Failed
type: string
subscriptions:
description: Each item includes a set of order actions, which will be applied to the same base subscription.
items:
properties:
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
orderActions:
description: The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.
items:
$ref: '#/definitions/CreateOrderOrderAction'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
ramp:
$ref: '#/definitions/RampRequest'
subscriptionNumber:
description: 'Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.
'
type: string
type: object
type: array
required:
- orderDate
type: object
GetOrdersResponse:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists; otherwise absent.
'
format: URL
type: string
orders:
items:
$ref: '#/definitions/Order'
type: array
type: object
CreateOrderOrderAction:
properties:
addProduct:
allOf:
- $ref: '#/definitions/CreateOrderRatePlanOverride'
- $ref: '#/definitions/CreateOrderProductOverride'
description: "Either a rate plan or offer can be added to a subscription through one order action, but not both; otherwise, an error occurs.\n - For a rate plan, the following fields are available:\n - `chargeOverrides`\n - `clearingExistingFeatures`\n - `customFields`\n - `externalCatalogPlanId`\n - `externallyManagedPlanId` \n - `productRatePlanId`\n - `productRatePlanNumber`\n - `subscriptionProductFeatures`\n - `uniqueToken`\n - For an offer, the following fields are available:\n - `customFields`\n - `productOfferId`\n - `productOfferNumber`\n - `ratePlanOverrides`\n - `subscriptionOfferUniqueToken`\n"
cancelSubscription:
$ref: '#/definitions/CancelSubscription'
changePlan:
$ref: '#/definitions/CreateChangePlan'
changeReason:
description: 'The change reason set for an order action when an order is created.
'
type: string
createSubscription:
$ref: '#/definitions/CreateOrderCreateSubscription'
customFields:
$ref: '#/definitions/OrderActionObjectCustomFields'
ownerTransfer:
$ref: '#/definitions/OwnerTransfer'
removeProduct:
$ref: '#/definitions/RemoveProduct'
renewSubscription:
$ref: '#/definitions/RenewSubscription'
resume:
$ref: '#/definitions/CreateOrderResume'
suspend:
$ref: '#/definitions/CreateOrderSuspend'
termsAndConditions:
$ref: '#/definitions/CreateOrderTermsAndConditions'
triggerDates:
description: "Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf [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 `ServiceActivation` field is not set for a `CreateSubscription` order action, a `Pending` order and a `Pending Activation` subscription are created.\n\nIf [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 `CustomerAcceptance` field is not set for a `CreateSubscription` order action, a `Pending` order and 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 a `Pending Activation` subscription are created instead.\n\nIf [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 `ServiceActivation` field is not set for either of the following order actions, 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](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nIf [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 `CustomerAcceptance` field is not set for either of the following order actions, 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](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
items:
$ref: '#/definitions/TriggerDate'
type: array
type:
description: "Type of order action.\n\nUnless the type of order action is `RenewSubscription`, you must use the corresponding field to provide information about the order action. For example, if the type of order action is `AddProduct`, you must set the `addProduct` field.\n\nZuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is `AddProduct`, Zuora returns an error if you set the `updateProduct` field.\n\nA [pending order](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/Pending_Order_and_Subscription) supports the following order actions:\n * CreateSubscription\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n * ChangePlan\n\nHowever, pending orders created through all order actions except for \"Create new subscription\":\n * Do not impact the subscription status.\n * Are in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). \n\nA pending order is created in either of the following conditions:\n * [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 date is not set in your \"Create an order\" call.\n * [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 date is not set in your \"Create an order\" call.\n * When a charge in the subscription has its `triggerEvent` field set as `SpecificDate` and the `specificTriggerDate` field is not set in your \"Create an order\" API call.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
enum:
- CreateSubscription
- TermsAndConditions
- AddProduct
- UpdateProduct
- RemoveProduct
- RenewSubscription
- CancelSubscription
- OwnerTransfer
- Suspend
- Resume
- ChangePlan
type: string
updateProduct:
allOf:
- $ref: '#/definitions/CreateOrderRatePlanUpdate'
- $ref: '#/definitions/CreateOrderOfferUpdate'
description: "Either a rate plan or offer can be updated in a subscription through one order action, but not both; otherwise, an error occurs.\n - For a rate plan, the following fields are available:\n - `chargeUpdates`\n - `clearingExistingFeatures`\n - `customFields`\n - `externalCatalogPlanId` \n - `ratePlanId`\n - `productRatePlanNumber`\n - `subscriptionRatePlanNumber`\n - `uniqueToken`\n - `specificUpdateDate`\n - `subscriptionProductFeatures`\n - `uniqueToken`\n - For an offer, the following fields are available:\n - `customFields`\n - `ratePlanUpdates`\n - `subscriptionOfferId`\n - `subscriptionOfferNumber`\n - `subscriptionOfferUniqueToken`\n"
required:
- type
type: object
InitialTerm:
description: The length of the period for the current subscription term.
properties:
period:
description: Specify only when the termType is 'TERMED'.
minimum: 0
type: integer
periodType:
description: Specify only when the termType is 'TERMED'.
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'The start date of the current term.
'
format: date
type: string
termType:
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
OneTimeFlatFeePricingOverride:
description: 'Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
properties:
listPrice:
description: 'Price of the charge.
'
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
required:
- listPrice
title: oneTimeFlatFee
type: object
GetOrderSuspend:
description: 'Information about an order action of type `Suspend`.
'
properties:
suspendDate:
description: "The suspend date when the suspension takes effect. \n"
format: date
type: string
suspendPeriods:
description: "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType` field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.\n\nThe total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
type: integer
suspendPeriodsType:
description: "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods` field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.\n\nThe period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
enum:
- Day
- Week
- Month
- Year
type: string
suspendPolicy:
description: 'Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.
'
enum:
- Today
- EndOfLastInvoicePeriod
- FixedPeriodsFromToday
- SpecificDate
type: string
suspendSpecificDate:
description: 'This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.
A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription''s contract effective date or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version) than the subscription''s term end date.
'
format: date
type: string
title: Suspend
type: object
BillToContactPostOrder:
allOf:
- description: 'Contact details associated with an account.
'
properties:
address1:
description: 'First line of the contact''s address. This is often a street address or a business name.
'
maxLength: 255
type: string
address2:
description: 'Second line of the contact''s address.
'
maxLength: 255
type: string
city:
description: 'City of the contact''s address.
'
maxLength: 40
type: string
contactDescription:
description: 'A description for the contact.
'
maxLength: 100
type: string
country:
description: 'Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax.
'
maxLength: 64
type: string
county:
description: 'County of the contact''s address.
'
maxLength: 32
type: string
fax:
description: 'Fax number of the contact.
'
maxLength: 40
type: string
firstName:
description: 'First name of the contact.
'
maxLength: 100
type: string
homePhone:
description: 'Home phone number of the contact.
'
maxLength: 40
type: string
lastName:
description: 'Last name of the contact.
'
maxLength: 100
type: string
mobilePhone:
description: 'Mobile phone number of the contact.
'
maxLength: 40
type: string
nickname:
description: 'Nickname of the contact.
'
maxLength: 100
type: string
otherPhone:
description: 'Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.
'
maxLength: 40
type: string
otherPhoneType:
description: 'Specifies the type of phone number in the `otherPhone` field.
'
enum:
- Work
- Mobile
- Home
- Other
type: string
personalEmail:
description: 'Personal email address of the contact.
'
format: email
maxLength: 80
type: string
postalCode:
description: 'ZIP code or other postal code of the contact''s address.
'
maxLength: 20
type: string
state:
description: 'State or province of the contact''s address.
'
maxLength: 40
type: string
taxRegion:
description: 'Region defined in your taxation rules. Only applicable if you use Zuora Tax.
'
maxLength: 32
type: string
workEmail:
description: 'Business email address of the contact.
'
format: email
maxLength: 80
type: string
workPhone:
description: 'Business phone number of the contact.
'
maxLength: 40
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
UsageFlatFeePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
type: object
RampRequest:
description: 'Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.
'
properties:
charges:
description: 'Container for the rate plan charges that are considered as part of the ramp deal.
* If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal.
* If this field is specified, either ''chargeNumber'' or ''uniqueToken'' must be specified.
'
items:
$ref: '#/definitions/RampChargeRequest'
type: array
delete:
description: "Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the `ramp` object. \n"
type: boolean
description:
description: The short description of the ramp.
type: string
intervals:
description: "Container for the intervals that the ramp is split into in its timeline. \n\nIt is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.\n"
items:
$ref: '#/definitions/RampIntervalRequest'
type: array
name:
description: The name of the ramp.
type: string
title: Ramp
type: object
ChargeUpdate:
description: The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.
properties:
billing:
$ref: '#/definitions/BillingUpdate'
chargeNumber:
description: "The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field. \n"
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
description:
type: string
effectiveDate:
$ref: '#/definitions/TriggerParams'
pricing:
allOf:
- $ref: '#/definitions/PricingUpdate'
description: 'Pricing information about the charge.
'
uniqueToken:
description: "description: |\n A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n"
type: string
type: object
OrderLineItemRetrieveOrder:
allOf:
- properties:
amendedByOrderOn:
description: 'The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.
'
type: string
amount:
description: 'The calculated gross amount for the Order Line Item.
'
type: number
amountWithoutTax:
description: 'The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the `amount` field.
If the tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the `amountWithoutTax` field equals that of the `amount` field.
If you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item.
'
type: number
id:
description: 'The sytem generated Id for the Order Line Item.
'
format: UUID
type: string
itemNumber:
description: 'The number for the Order Line Item.
'
type: string
originalOrderDate:
description: 'The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.
'
format: date
type: string
quantityFulfilled:
description: 'The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become ''SentToBilling'' or ''Complete'' state.
'
type: number
quantityPendingFulfillment:
description: 'The quantity that''s need to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become ''SentToBilling'' or ''Complete'' state.
'
type: number
type: object
- $ref: '#/definitions/OrderLineItemCommonRetrieveOrder'
CreateOrderTermsAndConditions:
description: 'Information about an order action of type `TermsAndConditions`.
'
properties:
autoRenew:
type: boolean
billToContactId:
description: "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
clearingExistingBillToContact:
default: false
description: 'Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: 'Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingPaymentTerm:
default: false
description: 'Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSequenceSet:
default: false
description: 'Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSoldToContact:
default: false
description: 'Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
lastTerm:
$ref: '#/definitions/LastTerm'
paymentTerm:
description: "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
renewalSetting:
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
items:
$ref: '#/definitions/RenewalTerm'
type: array
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
title: termsAndConditions
type: object
PreviewOrderChargeOverride:
description: 'Charge associated with a rate plan.
'
properties:
accountReceivableAccountingCode:
description: 'The accountReceivableAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.
'
type: string
adjustmentLiabilityAccountingCode:
description: 'The adjustmentLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
adjustmentRevenueAccountingCode:
description: 'The adjustmentRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
billing:
description: 'Billing information about the charge.
'
properties:
billCycleDay:
description: 'Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.
'
maximum: 31
minimum: 0
type: integer
billCycleType:
description: "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
enum:
- DefaultFromCustomer
- SpecificDayofMonth
- SubscriptionStartDay
- ChargeTriggerDay
- SpecificDayofWeek
type: string
billingPeriod:
description: 'Billing frequency of the charge. The value of this field controls the duration of each billing period.
If the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.
'
enum:
- Month
- Quarter
- Semi_Annual
- Annual
- Eighteen_Months
- Two_Years
- Three_Years
- Five_Years
- Specific_Months
- Subscription_Term
- Week
- Specific_Weeks
type: string
billingPeriodAlignment:
description: 'Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.
* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.
* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.
* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.
See the `billCycleType` field for information about how Zuora determines the billing day.
'
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
billingTiming:
description: 'Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).
'
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
specificBillingPeriod:
description: 'Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.
'
type: integer
weeklyBillCycleDay:
description: 'Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.
'
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
type: object
chargeModel:
description: 'The chargeModel of a standalone charge.
Supported charge models:
* `FlatFee`
* `PerUnit`
* `Volume`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
chargeNumber:
description: 'Charge number of the charge. For example, C-00000307.
If you do not set this field, Zuora will generate the charge number.
'
maxLength: 50
type: string
chargeType:
description: 'The chargeType of a standalone charge.
Supported charge types:
* `OneTime`
* `Recurring`
* `Usage`
* `DiscountFixedAmount`
* `DiscountPercentage`
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
contractAssetAccountingCode:
description: 'The contractAssetAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractLiabilityAccountingCode:
description: 'The contractLiabilityAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
contractRecognizedRevenueAccountingCode:
description: 'The contractRecognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
deferredRevenueAccountingCode:
description: 'The deferredRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
description:
description: 'Description of the charge.
'
maxLength: 500
type: string
drawdownRate:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).
'
type: number
endDate:
$ref: '#/definitions/EndConditions'
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in a Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.\n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.\n"
type: boolean
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isRollover:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The value is either "True" or "False". It determines whether the rollover fields are needed.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
name:
description: 'The name of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
pobPolicy:
description: 'The pobPolicy of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
prepaidQuantity:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).
'
type: number
pricing:
description: 'Pricing information about the charge.
'
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingOverride'
oneTimeFlatFee:
$ref: '#/definitions/OneTimeFlatFeePricingOverride'
oneTimePerUnit:
$ref: '#/definitions/OneTimePerUnitPricingOverride'
oneTimeTiered:
$ref: '#/definitions/OneTimeTieredPricingOverride'
oneTimeVolume:
$ref: '#/definitions/OneTimeVolumePricingOverride'
recurringDeliveryBased:
$ref: '#/definitions/RecurringDeliveryPricingOverride'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingOverride'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingOverride'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingOverride'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingOverride'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingOverride'
usageOverage:
$ref: '#/definitions/UsageOveragePricingOverride'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingOverride'
usageTiered:
$ref: '#/definitions/UsageTieredPricingOverride'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingOverride'
usageVolume:
$ref: '#/definitions/UsageVolumePricingOverride'
type: object
productCategory:
description: 'The productCategory of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productClass:
description: 'The productClass of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productFamily:
description: 'The productFamily of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productLine:
description: 'The productLine of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
productRatePlanChargeId:
description: 'Internal identifier of the product rate plan charge that the charge is based on.
'
type: string
productRatePlanChargeNumber:
description: 'Number of a product rate-plan charge for this subscription.
'
type: string
recognizedRevenueAccountingCode:
description: 'The recognizedRevenueAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled.
'
type: string
revRecCode:
description: 'Revenue Recognition Code
'
maxLength: 70
type: string
revRecTriggerCondition:
description: "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
enum:
- Contract Effective Date
- Service Activation Date
- Customer Acceptance Date
type: string
revenueRecognitionRuleName:
description: 'Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.
'
type: string
rolloverApply:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the priority of rollover, which is either first or last.
'
enum:
- ApplyFirst
- ApplyLast
type: string
rolloverPeriodLength:
default: null
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period length of the rollover fund.
'
type: integer
rolloverPeriods:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
This field defines the number of rollover periods, it is restricted to 3.
'
type: number
startDate:
$ref: '#/definitions/PreviewOrderTriggerParams'
taxCode:
description: 'The taxCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
taxMode:
description: "The taxMode of a standalone charge. \nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"
type: string
unBilledReceivablesAccountingCode:
description: 'The unBilledReceivablesAccountingCode of a standalone charge.
**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.
'
type: string
uniqueToken:
description: 'Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
'
maxLength: 50
type: string
validityPeriodType:
description: "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). \n"
enum:
- SUBSCRIPTION_TERM
- ANNUAL
- SEMI_ANNUAL
- QUARTER
- MONTH
type: string
required:
- productRatePlanChargeId
title: charge
type: object
DiscountPricingOverride:
description: 'Pricing information about a discount charge.
'
properties:
applyDiscountTo:
description: 'Specifies which type of charge the discount charge applies to.
'
enum:
- ONETIME
- RECURRING
- USAGE
- ONETIMERECURRING
- ONETIMEUSAGE
- RECURRINGUSAGE
- ONETIMERECURRINGUSAGE
type: string
applyToBillingPeriodPartially:
description: 'Allow the discount duration to be aligned with the billing period partially.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
type: boolean
discountAmount:
description: 'Only applicable if the discount charge is a fixed-amount discount.
'
type: number
discountApplyDetails:
description: 'Charge list of discount be applied to.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
items:
$ref: '#/definitions/DiscountApplyDetail'
type: array
discountClass:
description: 'The discount class defines the sequence in which discount product rate plan charges are applied.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
type: string
discountLevel:
description: 'Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.
'
enum:
- rateplan
- subscription
- account
type: string
discountPercentage:
description: 'Only applicable if the discount charge is a percentage discount.
'
type: number
originalDiscountAmount:
description: 'The manufacturer''s suggested retail discount price for standalone charge.
Only applicable if the standalone discount charge is a fixed-amount discount.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
originalDiscountPercentage:
description: 'The manufacturer''s suggested retail discount percentage for standalone charge.
Only applicable if the standalone discount charge is a percentage discount.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
priceChangeOption:
description: 'Specifies how Zuora changes the price of the charge each time the subscription renews.
'
enum:
- NoChange
- UseLatestProductCatalogPricing
type: string
title: discount
type: object
TimeSlicedTcbNetMetrics:
properties:
amount:
type: number
discountChargeNumber:
type: string
endDate:
format: date
type: string
generatedReason:
description: "Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
enum:
- IncreaseQuantity
- DecreaseQuantity
- ChangePrice
- Extension
- Contraction
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the subscription.
type: string
orderItemId:
description: "The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
type: string
startDate:
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
tax:
type: number
termNumber:
format: long
type: number
type:
description: Indicates whether this metrics is for a regular charge or a discount charge.
enum:
- Regular
- Discount
type: string
type: object
CreatePaymentMethodACH:
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
bankABACode:
description: 'The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.
'
type: string
bankAccountName:
description: 'The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.
For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap''s `firstName` and `lastName` fields.
'
maxLength: 70
type: string
bankAccountNumber:
description: 'The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`.
'
maxLength: 30
type: string
bankAccountType:
description: 'The type of bank account associated with the ACH payment. This field is only required if the `type` field is set to `ACH`.
When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.
'
enum:
- BusinessChecking
- BusinessSaving
- Checking
- Saving
type: string
bankName:
description: 'The name of the bank where the ACH payment account is held. This field is only required if the `type` field is set to `ACH`.
When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.
'
maxLength: 70
type: string
city:
description: "City, 40 characters or less.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n \n"
type: string
country:
description: 'Country, must be a valid country name or abbreviation.
See [Country Names and Their ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes) for the list of supported country names and abbreviations.
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State, must be a valid state name or 2-character abbreviation.
See [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
PreviewOrderChargeUpdate:
properties:
billing:
$ref: '#/definitions/BillingUpdate'
chargeNumber:
description: 'The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
description:
type: string
effectiveDate:
$ref: '#/definitions/PreviewOrderTriggerParams'
prepaidQuantity:
description: "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0). \n"
type: number
pricing:
allOf:
- $ref: '#/definitions/PreviewOrderPricingUpdate'
description: 'Pricing information about the charge.
'
uniqueToken:
description: 'A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.
'
type: string
type: object
RatePlanFeatureOverride:
description: 'Information about feature in rate plan.
'
properties:
customFields:
$ref: '#/definitions/RatePlanFeatureOverrideCustomFields'
description:
description: A description of the feature.
maxLength: 500
type: string
featureId:
description: 'Internal identifier of the feature in the product catalog.
'
type: string
id:
description: 'Internal identifier of the rate plan feature override.
'
type: string
title: ratePlanFeature
type: object
TimeSlicedNetMetrics:
properties:
amount:
type: number
discountChargeNumber:
type: string
endDate:
format: date
type: string
generatedReason:
description: "Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
enum:
- IncreaseQuantity
- DecreaseQuantity
- ChangePrice
- Extension
- Contraction
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the subscription.
type: string
orderItemId:
description: "The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
type: string
startDate:
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
termNumber:
format: long
type: number
type:
description: Indicates whether this metrics is for a regular charge or a discount charge.
enum:
- Regular
- Discount
type: string
type: object
ChargeModelDataOverride:
description: 'Container for charge model configuration data.
**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
'
properties:
chargeModelConfiguration:
properties:
customFieldPerUnitRate:
description: 'The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.
This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
'
type: string
customFieldTotalAmount:
description: "The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`. \n\nThis field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
type: string
formula:
description: 'The pricing formula to calculate actual rating amount.
This field is only available for charges that use the Multi-Attribute Pricing charge model.
'
type: string
type: object
quantity:
description: 'Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the `quantity()` function.
This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.
'
minimum: 0
type: number
tiers:
description: 'List of cumulative pricing tiers in the charge.
**Note**: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
title: chargeModelData
type: object
CreateOrderChangePlanRatePlanOverride:
description: "Information about the new product rate plan to add. \n"
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/ChangePlanChargeOverride'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externalCatalogPlanId:
description: 'An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.
**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
isFromExternalCatalog:
description: 'Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: boolean
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanName:
description: 'Name of the standalone rate plan.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/CreateOrderRatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
title: ratePlan
type: object
processingOptionsOrdersWithDelayedCapturePayment:
description: 'The container for billing processing options and payment processing options.
**Note:**
- This field is not supported in draft orders.
- When you use the "Create an order" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created.
- When you use the "Create an order" operation to cancel a subscription with `refund` and `writeOff`, if the `refund` or `writeOff` fails, `cancelSubscription`, `runBilling`, and `collectPayment` still can succeed.
- When you use the "Create an order" operation, the `collectPayment` and `refund` fields cannot be set to `true` simultaneously. Otherwise, the order will not be proceeded.
'
properties:
applicationOrder:
description: "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
items:
type: string
type: array
applyCredit:
description: "Whether to automatically apply credit memos or unapplied payments, or both to an invoice.\n\nIf the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. \n\n\n**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
type: boolean
applyCreditBalance:
description: 'Indicates if any credit balance on a customer''s account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.
'
type: boolean
billingOptions:
properties:
creditMemoReasonCode:
description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.
type: string
documentDate:
description: 'The invoice date displayed on the invoice.
'
format: date
type: string
generateDraftInvoice:
description: 'Indicates if the current request needs to generate a draft invoice.
Values are:
* `true`
* `false` (default)
'
type: boolean
targetDate:
description: 'Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).
'
format: date
type: string
type: object
collectPayment:
description: 'Indicates if the current request needs to collect payments. This value can not be ''true'' when ''runBilling'' flag is ''false''.
'
type: boolean
electronicPaymentOptions:
description: 'Container for the electronic payment options.
'
properties:
authTransactionId:
description: 'The authorization transaction ID from the payment gateway.
When you create a payment to capture the funds that have been authorized through [Create authorization](/api-references/api/operation/POST_CreateAuthorization/), pass in the `authTransactionId` field. It is highly recommended to also pass in `gatewayOrderId` that you used when authorizing the funds. `authTransactionId` is required, while `gatewayOrderId` is optional.
'
maxLength: 50
type: string
gatewayOrderId:
description: "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n\nGateways check duplicates on the gateway order ID to ensure that the same transaction is not entered twice accidentally. \n\nThis ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.\n\nWhen you create a payment to capture the funds that have been authorized through [Create authorization](/api-references/api/operation/POST_CreateAuthorization/), pass in the `authTransactionId` field. It is highly recommended to also pass in `gatewayOrderId` that you used when authorizing the funds. `authTransactionId` is required, while `gatewayOrderId` is optional.\n"
maxLength: 50
type: string
paymentGatewayId:
description: 'Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.
'
type: string
paymentMethodId:
description: 'Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.
'
type: string
type: object
refund:
description: "Indicates whether to refund after subscription cancelation. Default is `false`. \n\n**Note**: When refunding a subscription that is not invoiced separately, if you do not enable the Invoice Item Settlement feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n"
type: boolean
refundAmount:
description: 'Indicates the amount to be refunded. Required if the `refund` field is `true`.
'
type: number
refundReasonCode:
description: 'A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.
'
type: string
runBilling:
description: 'Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.
'
type: boolean
writeOff:
description: "Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`.\n\n**Note**: \n- When refunding a subscription that is not invoiced separately, if you do not enable the Invoice Item Settlement feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n- The Invoice Settlement feature must have been enabled for write-off.\n"
type: boolean
writeOffBehavior:
description: "The financial information of the credit memo items generated to write off the invoice balance. \n\n**Note:** \n - All the credit memo items that are used to write off the invoice will be applied with the same financial information.\n - Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.\n"
properties:
financeInformation:
description: 'Container for the finance information related to the credit memo items that are created for invoice write-off.
'
properties:
deferredRevenueAccountingCode:
description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.
'
maxLength: 100
minLength: 0
type: string
onAccountAccountingCode:
description: 'The accounting code that maps to an on account in your accounting system.
'
maxLength: 100
minLength: 0
type: string
recognizedRevenueAccountingCode:
description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.
'
maxLength: 100
minLength: 0
type: string
revenueRecognitionRuleName:
description: 'The name of the revenue recognition rule governing the revenue schedule.
'
maxLength: 100
minLength: 0
type: string
type: object
type: object
type: object
CreateOrderRatePlanOverride:
description: "Information about an order action of type `addProduct`. \n\nIf you want to create a pending order through the \"Add product\" order action, and if the charge's trigger condition is `Specific Date`, you must set a charge number in the `chargeNumber` field for the \"Add product\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you.\n\nSee more information about pending orders in Pending orders and subscriptions. \n"
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/CreateOrderChargeOverride'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externalCatalogPlanId:
description: 'An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.
**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
isFromExternalCatalog:
description: 'Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: boolean
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanName:
description: 'Name of the standalone rate plan.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/CreateOrderRatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
title: ratePlan
type: object
SoldToContact:
allOf:
- description: 'Contact details associated with an account.
'
properties:
address1:
description: 'First line of the contact''s address. This is often a street address or a business name.
'
maxLength: 255
type: string
address2:
description: 'Second line of the contact''s address.
'
maxLength: 255
type: string
city:
description: 'City of the contact''s address.
'
maxLength: 40
type: string
country:
description: 'Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.
'
maxLength: 64
type: string
county:
description: 'County of the contact''s address.
'
maxLength: 32
type: string
fax:
description: 'Fax number of the contact.
'
maxLength: 40
type: string
firstName:
description: 'First name of the contact.
'
maxLength: 100
type: string
homePhone:
description: 'Home phone number of the contact.
'
maxLength: 40
type: string
lastName:
description: 'Last name of the contact.
'
maxLength: 100
type: string
mobilePhone:
description: 'Mobile phone number of the contact.
'
maxLength: 40
type: string
nickname:
description: 'Nickname of the contact.
'
maxLength: 100
type: string
otherPhone:
description: 'Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.
'
maxLength: 40
type: string
otherPhoneType:
description: 'Specifies the type of phone number in the `otherPhone` field.
'
enum:
- Work
- Mobile
- Home
- Other
type: string
personalEmail:
description: 'Personal email address of the contact.
'
format: email
maxLength: 80
type: string
postalCode:
description: 'ZIP code or other postal code of the contact''s address.
'
maxLength: 20
type: string
state:
description: 'State or province of the contact''s address.
'
maxLength: 40
type: string
taxRegion:
description: 'Region defined in your taxation rules. Only applicable if you use Zuora Tax.
'
maxLength: 32
type: string
workEmail:
description: 'Business email address of the contact.
'
format: email
maxLength: 80
type: string
workPhone:
description: 'Business phone number of the contact.
'
maxLength: 40
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
CreateOrderRatePlanFeatureOverride:
description: 'Information about feature in rate plan.
'
properties:
customFields:
$ref: '#/definitions/RatePlanFeatureOverrideCustomFields'
description:
description: A description of the feature.
maxLength: 500
type: string
featureId:
description: 'Internal identifier of the feature in the product catalog.
'
type: string
required:
- featureId
title: ratePlanFeature
type: object
DeliveryScheduleParams:
properties:
frequency:
description: 'Specifies the frequency for delivery schedule
'
enum:
- Weekly
type: string
friday:
description: 'Indicates whether delivery on friday.
'
type: boolean
monday:
description: 'Indicates whether delivery on monday.
'
type: boolean
saturday:
description: 'Indicates whether delivery on saturday.
'
type: boolean
sunday:
description: 'Indicates whether delivery on sunday.
'
type: boolean
thursday:
description: 'Indicates whether delivery on thursday.
'
type: boolean
tuesday:
description: 'Indicates whether delivery on tuesday.
'
type: boolean
wednesday:
description: 'Indicates whether delivery on wednesday.
'
type: boolean
type: object
UsagePerUnitPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
type: object
TermsAndConditions:
description: 'Information about an order action of type `TermsAndConditions`.
'
properties:
autoRenew:
type: boolean
billToContactId:
description: "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
clearingExistingBillToContact:
default: false
description: 'Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: 'Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingPaymentTerm:
default: false
description: 'Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSequenceSet:
default: false
description: 'Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
clearingExistingSoldToContact:
default: false
description: 'Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
'
type: boolean
initialTerm:
$ref: '#/definitions/InitialTerm'
invoiceTemplateId:
description: "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
paymentTerm:
description: "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
renewalSetting:
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
items:
$ref: '#/definitions/RenewalTerm'
type: array
sequenceSetId:
description: "The ID of the sequence set associated with the subscription.\n \n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
soldToContactId:
description: "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
type: string
title: termsAndConditions
type: object
PriceIntervalWithTiers:
properties:
duration:
description: 'Duration period of this interval.
'
minimum: 1
type: integer
sequence:
description: 'Index of the interval in the interval pricing.
'
minimum: 1
type: integer
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
type:
description: 'Interval type of this pricing.
'
enum:
- Day
- Month
- Infinity
type: string
title: priceIntervalWithTiers
type: object
CreateChangePlan:
description: "Information about an order action of type `changePlan`. \n\nUse the change plan type of order action to replace the existing rate plans in a subscription with other rate plans.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n\nIf you want to create a pending order through the \"change plan\" order action, and if the charge's trigger condition is `Specific Date`, you must set a charge number in the `chargeNumber` field for the \"change plan\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you.\n\nSee more information about pending orders in Pending orders and subscriptions.\n"
properties:
effectivePolicy:
description: "The default value for the `effectivePolicy` field is as follows:\n * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n * Otherwise, the effective policy is `SpecificDate` by default.\n\n**Notes**: \n * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the billing trigger dates for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to `Yes`:\n * Require Customer Acceptance of Orders?\n * Require Service Activation of Orders?\n \n * When setting this field to `SpecificDate`, you must also set the contract effective date in the `triggerDates` field as follows:\n * Set the `name` field as `ContractEffective`\n * Specify a date for the `triggerDate` field\n"
enum:
- EffectiveImmediately
- EffectiveEndOfBillingPeriod
- SpecificDate
type: string
externalCatalogPlanId:
description: 'An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.
**Note:** Please provide only one of `externalCatalogPlanId`, `ratePlanId` or `productRatePlanId`. If more than 1 field is provided then the request would fail.
'
type: string
newProductRatePlan:
$ref: '#/definitions/CreateOrderChangePlanRatePlanOverride'
productRatePlanId:
description: 'ID of the product rate plan that the removed rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'ID of the rate plan to remove. This can be the latest version or any history version of ID. Note that the removal of a rate plan through the Change Plan order action supports the function of removal before future-dated removals, as in a Remove Product order action.
'
type: string
resetBcd:
default: false
description: 'If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD.
'
type: boolean
subType:
description: 'Use this field to choose the sub type for your change plan order action.
However, if you do not set this field, the field will be automatically generated by the system according to the following rules:
When the old and new rate plans are within the same Grading catalog group:
* If the grade of new plan is greater than that of the old plan, this is an "Upgrade".
* If the grade of new plan is less than that of the old plan, this is a "Downgrade".
* If the grade of new plan equals that of the old plan, this is a "Crossgrade".
When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged".
'
enum:
- Upgrade
- Downgrade
- Crossgrade
- PlanChanged
type: string
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
required:
- newProductRatePlan
title: createChangePlan
type: object
SoldToContactPostOrder:
allOf:
- description: 'Contact details associated with an account.
'
properties:
address1:
description: 'First line of the contact''s address. This is often a street address or a business name.
'
maxLength: 255
type: string
address2:
description: 'Second line of the contact''s address.
'
maxLength: 255
type: string
city:
description: 'City of the contact''s address.
'
maxLength: 40
type: string
contactDescription:
description: "A description for the contact. \n"
maxLength: 100
type: string
country:
description: 'Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.
'
maxLength: 64
type: string
county:
description: 'County of the contact''s address.
'
maxLength: 32
type: string
fax:
description: 'Fax number of the contact.
'
maxLength: 40
type: string
firstName:
description: 'First name of the contact.
'
maxLength: 100
type: string
homePhone:
description: 'Home phone number of the contact.
'
maxLength: 40
type: string
lastName:
description: 'Last name of the contact.
'
maxLength: 100
type: string
mobilePhone:
description: 'Mobile phone number of the contact.
'
maxLength: 40
type: string
nickname:
description: 'Nickname of the contact.
'
maxLength: 100
type: string
otherPhone:
description: 'Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.
'
maxLength: 40
type: string
otherPhoneType:
description: 'Specifies the type of phone number in the `otherPhone` field.
'
enum:
- Work
- Mobile
- Home
- Other
type: string
personalEmail:
description: 'Personal email address of the contact.
'
format: email
maxLength: 80
type: string
postalCode:
description: 'ZIP code or other postal code of the contact''s address.
'
maxLength: 20
type: string
state:
description: 'State or province of the contact''s address.
'
maxLength: 40
type: string
taxRegion:
description: 'Region defined in your taxation rules. Only applicable if you use Zuora Tax.
'
maxLength: 32
type: string
workEmail:
description: 'Business email address of the contact.
'
format: email
maxLength: 80
type: string
workPhone:
description: 'Business phone number of the contact.
'
maxLength: 40
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
PreviewAccountInfo:
description: 'Information about the account that will own the order.
'
properties:
billCycleDay:
description: Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
maximum: 31
minimum: 0
type: integer
currency:
description: 'ISO 3-letter currency code (uppercase). For example, USD.
'
maxLength: 3
type: string
customFields:
$ref: '#/definitions/AccountObjectCustomFields'
soldToContact:
$ref: '#/definitions/PreviewContactInfo'
taxInfo:
$ref: '#/definitions/TaxInfo'
required:
- currency
- billCycleDay
title: previewAccountInfo
type: object
BillingUpdate:
properties:
billingPeriodAlignment:
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
type: object
CreateOrderRatePlanUpdate:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
chargeUpdates:
description: 'Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.
'
items:
$ref: '#/definitions/CreateOrderChargeUpdate'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externalCatalogPlanId:
description: 'An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.
**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'The id of the rate plan to be updated. It can be the latest version or any history version id.
'
type: string
specificUpdateDate:
description: 'The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.
See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
'
format: date
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/CreateOrderRatePlanFeatureOverride'
type: array
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
uniqueToken:
description: 'A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.
'
type: string
title: updateRateplan
type: object
PreviewContactInfo:
properties:
city:
maxLength: 40
type: string
country:
description: Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country to calculate tax.
maxLength: 64
type: string
county:
maxLength: 32
type: string
postalCode:
maxLength: 20
type: string
state:
maxLength: 40
type: string
taxRegion:
maxLength: 32
type: string
type: object
RatePlanFeatureOverrideCustomFields:
additionalProperties:
description: 'Custom fields of the feature. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'A container for custom fields of the feature.
'
title: ratePlanFeatureCustom
type: object
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccountPaymentMethodCreditCard:
properties:
cardHolderInfo:
$ref: '#/definitions/CreatePaymentMethodCardholderInfo'
cardNumber:
description: 'Credit card number.
'
type: string
cardType:
description: 'The type of the credit card.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
'
type: string
checkDuplicated:
description: "Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.\n\nWith this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.\n \nThe following fields are used for the duplication check:\n * `cardHolderName`\n * `expirationMonth`\n * `expirationYear`\n * `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example, `****1234`. \n"
type: boolean
expirationMonth:
description: 'One or two digit expiration month (1-12) of the credit card.
'
type: string
expirationYear:
description: 'Four-digit expiration year of the credit card.
'
type: string
mitConsentAgreementRef:
description: 'Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.
'
maxLength: 128
type: string
mitConsentAgreementSrc:
description: 'Required if you set the `mitProfileAction` field. Specify how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
'
enum:
- External
type: string
mitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
mitProfileAction:
description: "Specifies how Zuora creates and activates the stored credential profile.\n\n* `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n\n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n\n\n* `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n\nIf you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n"
enum:
- Activate
- Persist
type: string
mitProfileAgreedOn:
description: 'The date on which the profile is agreed. The date format is `yyyy-mm-dd`.
'
format: date
type: string
mitProfileType:
description: 'Required if you set the `mitProfileAction` field. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
'
enum:
- Recurring
type: string
securityCode:
description: 'CVV or CVV2 security code of the credit card.
To ensure PCI compliance, this value is not stored and cannot be queried.
'
type: string
type: object
PreviewOrderOrderAction:
properties:
addProduct:
$ref: '#/definitions/PreviewOrderRatePlanOverride'
cancelSubscription:
$ref: '#/definitions/CancelSubscription'
changePlan:
$ref: '#/definitions/CreateChangePlan'
changeReason:
description: 'The change reason set for an order action when an order is created.
'
type: string
createSubscription:
$ref: '#/definitions/PreviewOrderCreateSubscription'
customFields:
$ref: '#/definitions/OrderActionObjectCustomFields'
ownerTransfer:
$ref: '#/definitions/OwnerTransfer'
removeProduct:
$ref: '#/definitions/RemoveProduct'
renewSubscription:
$ref: '#/definitions/RenewSubscription'
resume:
$ref: '#/definitions/CreateOrderResume'
suspend:
$ref: '#/definitions/CreateOrderSuspend'
termsAndConditions:
$ref: '#/definitions/CreateOrderTermsAndConditions'
triggerDates:
description: "Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf the service activation date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Activation` subscription.\n\nIf the customer acceptance date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Acceptance` subscription. If the service activation date field is at the same time required and skipped (or set as null), it will be a `Pending Activation` subscription.\n"
items:
$ref: '#/definitions/TriggerDate'
type: array
type:
description: 'Type of order action.
Unless the type of order action is `RenewSubscription`, you must use the corresponding field to provide information about the order action. For example, if the type of order action is `AddProduct`, you must set the `addProduct` field.
Zuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is `AddProduct`, Zuora returns an error if you set the `updateProduct` field.
**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.
'
enum:
- CreateSubscription
- TermsAndConditions
- AddProduct
- UpdateProduct
- RemoveProduct
- RenewSubscription
- CancelSubscription
- OwnerTransfer
- Suspend
- Resume
- ChangePlan
type: string
updateProduct:
$ref: '#/definitions/PreviewOrderRatePlanUpdate'
required:
- type
type: object
POSTOrderPreviewAsyncRequestType:
example:
customFields: {}
description: This is a description for the Order.
existingAccountNumber: A00000101
orderDate: '2018-10-01'
orderLineItems:
- amountPerUnit: 50
billingTrigger: BillImmediately
customFields:
someField__c: some string
deferredRevenueAccountingCode: Unearned Revenues
description: With Dual Stereo Microphones, HD 1080p, Black
itemName: webcam
itemType: Product
listPricePerUnit: 59
productCode: C9201
purchaseOrderNumber: 960-000764
quantity: 2
recognizedRevenueAccountingCode: Earned Revenues
revenueRecognitionRule: recognized upon invoice
taxCode: '8018'
taxMode: TaxInclusive
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
previewOptions:
previewThruType: SpecificDate
previewTypes:
- OrderMetrics
- BillingDocs
- ChargeMetrics
specificPreviewThruDate: '2019-01-01'
subscriptions:
- orderActions:
- triggerDates:
- name: ContractEffective
triggerDate: '2018-12-01'
- name: ServiceActivation
triggerDate: '2018-12-01'
- name: CustomerAcceptance
triggerDate: '2018-12-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- chargeNumber: C-00000210
pricing:
recurringPerUnit:
listPrice: 20
ratePlanId: 2c98919c67a5ae9d0167a68f8eb20262
subscriptionNumber: A-S00000100
- orderActions:
- suspend:
suspendPolicy: Today
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-01'
- name: ServiceActivation
triggerDate: '2018-12-01'
- name: CustomerAcceptance
triggerDate: '2018-12-01'
type: Suspend
subscriptionNumber: A-S00000101
- orderActions:
- resume:
extendsTerm: true
resumePeriods: 10
resumePeriodsType: Day
resumePolicy: FixedPeriodsFromSuspendDate
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-12'
- name: ServiceActivation
triggerDate: '2018-12-12'
- name: CustomerAcceptance
triggerDate: '2018-12-12'
type: Resume
subscriptionNumber: A-S00000102
properties:
category:
default: NewSales
description: 'Category of the order to indicate a product sale or return. Default value is `NewSales`.
'
enum:
- NewSales
- Return
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: "The account number that this order will be created under. \n\nNote that invoice owner account of the subscriptions included in this order should be the same with the account of the order.\n"
maxLength: 70
type: string
orderDate:
description: The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date.
format: date
type: string
orderLineItems:
description: "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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. \n\nWith 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. \n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
items:
$ref: '#/definitions/CreateOrderOrderLineItem'
type: array
orderNumber:
description: "The order number of this order. \n**Note:** Make sure the order number does not contain a slash.\n"
maxLength: 100
type: string
previewAccountInfo:
$ref: '#/definitions/PreviewAccountInfo'
previewOptions:
$ref: '#/definitions/PreviewOptions'
reasonCode:
description: 'Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.
'
maxLength: 255
type: string
subscriptions:
description: Each item includes a set of order actions, which will be applied to the same base subscription.
items:
properties:
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
orderActions:
description: The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.
items:
$ref: '#/definitions/PreviewOrderOrderAction'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
ramp:
$ref: '#/definitions/RampRequest'
subscriptionNumber:
description: 'Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.
'
type: string
type: object
type: array
required:
- orderDate
- previewOptions
type: object
PreviewOrderTriggerParams:
description: 'Specifies when a charge becomes active.
'
properties:
specificTriggerDate:
description: "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n"
format: date
type: string
triggerEvent:
description: 'Condition for the charge to become active.
If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.
'
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
- SpecificDate
type: string
title: startDate
type: object
UsageVolumePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
ratingGroup:
description: "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
type: string
tiers:
description: 'List of variable pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
uom:
description: 'Unit of measure of the standalone charge.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.
'
title: usageVolume
RenewalTerm:
properties:
period:
description: 'Duration of the renewal term in months, years, days, or weeks, depending on the value of the `periodType` field.
'
type: integer
periodType:
description: 'Unit of time that the renewal term is measured in.
'
enum:
- Month
- Year
- Day
- Week
type: string
type: object
CreatePaymentMethodCommon:
properties:
accountKey:
description: 'Internal ID of the customer account that will own the payment method.
'
type: string
authGateway:
description: 'Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.
If you do not set this field, Zuora will use one of the following payment gateways instead:
* The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.
* The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.
'
type: string
ipAddress:
description: "The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n\nFor validating SEPA payment methods on Stripe v2, this field is required.\n"
type: string
makeDefault:
default: false
description: 'Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set.
'
type: boolean
type: object
OrderDeltaMrr:
allOf:
- $ref: '#/definitions/OrderDeltaMetric'
description: 'Order Delta Mrr. This is a metric that reflects the change to the TCV on rate plan charge object as the result of the order.
'
type: object
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount:
allOf:
- description: 'Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.
**Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
If you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.
'
properties:
accountNumber:
description: 'Account number. For example, A00000001.
'
maxLength: 70
type: string
additionalEmailAddresses:
description: 'List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.
'
maxLength: 1200
type: string
allowInvoiceEdit:
description: "Indicates if associated invoices can be edited.\nValues are: \n\n* `true`\n* `false` (default)\n"
type: boolean
autoPay:
description: 'Specifies whether future payments are automatically billed when they are due.
'
type: boolean
batch:
description: 'Name of the billing batch that the account belongs to. For example, Batch1.
'
type: string
billCycleDay:
description: 'Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
'
maximum: 31
minimum: 0
type: integer
billToContact:
$ref: '#/definitions/BillToContactPostOrder'
communicationProfileId:
description: 'Internal identifier of the communication profile that Zuora uses when sending notifications to the account''s contacts.
'
type: string
creditCard:
$ref: '#/definitions/creditCard'
creditMemoTemplateId:
description: '**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
'
type: string
crmId:
description: 'External identifier of the account in a CRM system.
'
maxLength: 100
type: string
currency:
description: 'ISO 3-letter currency code (uppercase). For example, USD.
'
type: string
customFields:
$ref: '#/definitions/AccountObjectCustomFields'
customerServiceRepName:
description: 'Name of the account''s customer service representative, if applicable.
'
maxLength: 50
type: string
debitMemoTemplateId:
description: '**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
'
type: string
hpmCreditCardPaymentMethodId:
description: 'The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.
If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,
but not both.
For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.
'
type: string
invoiceDeliveryPrefsEmail:
description: "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account. \n"
type: boolean
invoiceDeliveryPrefsPrint:
description: "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
type: boolean
invoiceTemplateId:
description: 'Internal identifier of the invoice template that Zuora uses when generating invoices for the account.
'
type: string
name:
description: 'Account name.
'
maxLength: 255
type: string
notes:
description: 'Notes about the account. These notes are only visible to Zuora users.
'
maxLength: 65535
type: string
parentId:
description: Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled.
type: string
paymentGateway:
description: 'The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.
'
maxLength: 40
type: string
paymentMethod:
$ref: '#/definitions/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccountPaymentMethod'
paymentTerm:
description: 'Name of the payment term associated with the account. For example, "Net 30". The payment term determines the due dates of invoices.
'
type: string
purchaseOrderNumber:
description: 'The number of the purchase order associated with this account. Purchase order information generally comes from customers.
'
maxLength: 100
type: string
salesRep:
description: 'The name of the sales representative associated with this account, if applicable.
'
maxLength: 50
type: string
soldToContact:
$ref: '#/definitions/SoldToContactPostOrder'
taxInfo:
$ref: '#/definitions/TaxInfo'
required:
- name
- currency
- billCycleDay
- billToContact
type: object
- $ref: '#/definitions/DataAccessControlField'
CreatePaymentMethodApplePayAdyen:
properties:
applePaymentData:
description: 'This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay).
'
type: string
type: object
CreateOrderResume:
description: 'Information about an order action of type `Resume`.
'
properties:
extendsTerm:
description: 'Specifies whether to extend the subscription term by the length of time the suspension is in effect.
'
type: boolean
resumePeriods:
description: "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriodsType` field. \n\nThe total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
type: integer
resumePeriodsType:
description: "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriods` field.\n\nThe period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
enum:
- Day
- Week
- Month
- Year
type: string
resumePolicy:
description: "Resume methods. Specify a way to resume a subscription. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information.\n\nIf `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. \n"
enum:
- Today
- FixedPeriodsFromSuspendDate
- FixedPeriodsFromToday
- SpecificDate
- SuspendDate
type: string
resumeSpecificDate:
description: 'This field is applicable only when the `resumePolicy` field is set to `SpecificDate`.
A specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.
'
format: date
type: string
required:
- resumePolicy
title: Resume
type: object
UsageOveragePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
includedUnits:
description: 'Number of free units that may be consumed.
'
minimum: 0
type: number
numberOfPeriods:
description: 'Number of periods that Zuora considers when calculating overage charges with overage smoothing.
'
minimum: 1
type: integer
overagePrice:
description: 'Price per overage unit consumed.
'
type: number
overageUnusedUnitsCreditOption:
description: 'Specifies whether to credit the customer for unused units.
If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.
'
enum:
- NoCredit
- CreditBySpecificRate
type: string
unusedUnitsCreditRates:
description: 'Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.
'
title: usageOverage
PreviewOrderRatePlanOverride:
description: 'Rate plan associated with a subscription.
'
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/PreviewOrderChargeOverride'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
isFromExternalCatalog:
description: 'Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: boolean
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanName:
description: 'Name of the standalone rate plan.
**Note:** This field is available when the Standalone Orders feature is enabled.
'
type: string
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/CreateOrderRatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
required:
- productRatePlanId
title: ratePlan
type: object
GetOfferRatePlanOverride:
description: 'Rate plan associated with a subscription.
'
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/ChargeOverride'
type: array
clearingExistingFeatures:
description: "Specifies whether all features in the rate plan will be cleared. \n"
type: boolean
customFields:
$ref: '#/definitions/OrdersRatePlanObjectCustomFields'
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
'
type: string
newRatePlanId:
description: 'Internal identifier of the rate plan.
'
type: string
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan is based on.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
sequence:
description: 'The sequence in offer rateplan override.
'
type: integer
subscriptionProductFeatures:
description: 'List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
'
items:
$ref: '#/definitions/RatePlanFeatureOverride'
type: array
uniqueToken:
description: 'Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
'
maxLength: 50
type: string
required:
- productRatePlanId
title: ratePlan
type: object
CreateOrderOrderLineItem:
allOf:
- $ref: '#/definitions/OrderLineItemCommonPostOrder'
RampIntervalChargeDeltaMetrics:
properties:
chargeNumber:
description: The number of the rate plan charge.
type: string
deltaDiscountTcb:
description: The discount delta amount for the TCB.
type: number
deltaDiscountTcv:
description: The discount delta amount for the TCV.
type: number
deltaGrossTcb:
description: The TCB delta value before discount charges are applied.
type: number
deltaGrossTcv:
description: The TCV delta value before discount charges are applied.
type: number
deltaMrr:
description: The MRR changing history of the current rate plan charge in the current ramp interval.
items:
properties:
discount:
description: The discount delta amount for the MRR.
type: number
endDate:
description: The end date.
format: date
type: string
gross:
description: The MRR delta amount before discounts charges are applied.
type: number
net:
description: The MRR delta amount after discounts charges are applied.
type: number
startDate:
description: The start date.
format: date
type: string
type: object
type: array
deltaNetTcb:
description: The TCB delta value after discount charges are applied.
type: number
deltaNetTcv:
description: The TCV delta value after discount charges are applied.
type: number
deltaQuantity:
description: The charge quantity changing history of the current rate plan charge in the current ramp interval.
items:
properties:
amount:
description: The delta amount of the charge quantity.
type: number
endDate:
description: The end date.
format: date
type: string
startDate:
description: The start date.
format: date
type: string
type: object
type: array
productRatePlanChargeId:
description: The ID of the corresponding product rate plan charge.
type: string
subscriptionNumber:
description: The number of the subscription that the current rate plan charge belongs to.
type: string
title: intervalDeltaMetrics
type: object
JobResult:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
accountId:
description: The account ID for the order. This field is returned only when the `returnIds` query parameter in the "Create an order asynchronously" operation is set to `true`.
type: string
accountNumber:
description: The account number for the order.
type: string
creditMemoIds:
description: An array of the credit memo IDs that are generated in the "Create an order asynchronously" operation. This field is returned only when the `returnIds` query parameter in the "Create an order asynchronously" operation is set to `true`.
items:
type: string
type: array
creditMemoNumbers:
description: 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.
items:
type: string
type: array
invoiceId:
description: An array of the invoice IDs that are generated in the "Create an order asynchronously" operation. This field is returned only when the `returnIds` query parameter in the "Create an order asynchronously" operation is set to `true`.
items:
type: string
type: string
invoiceNumbers:
description: 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.
items:
type: string
type: array
orderId:
description: The ID of the order created. This field is returned only when the `returnIds` query parameter in the "Create an order asynchronously" operation is set to `true`.
type: string
orderLineItems:
items:
properties:
id:
description: The sytem generated Id for the Order Line Item.
format: UUID
type: string
itemNumber:
description: The number for the Order Line Item.
format: UUID
type: string
type: object
type: array
orderNumber:
description: The order number of the order created.
type: string
paidAmount:
description: The total amount collected in this order request.
type: string
paymentId:
description: The ID of the payment that is collected in the "Create an order asynchronously" operation. This field is returned only when the `returnIds` query parameter in the "Create an order asynchronously" operation is set to `true`.
type: string
paymentNumber:
description: The payment number that collected in this order request.
type: string
ramps:
description: '**Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_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://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
The ramp definitions created by this order request.
'
items:
properties:
rampNumber:
description: The number of the ramp definition.
type: string
subscriptionNumber:
description: The number of the subscription that this ramp deal definition is applied to.
type: string
type: object
type: array
status:
description: Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action.
enum:
- Draft
- Pending
- Completed
type: string
subscriptionIds:
description: Container for the IDs of the subscriptions in the order. This field is returned only when the `returnIds` query parameter in the "Create an order asynchronously" operation is set to `true`.
items:
type: string
type: array
subscriptionNumbers:
description: '**Note:** This field is in Zuora REST API version control. Supported minor versions are 222.0 or earlier [available versions](/api-references/api/overview/#section/API-Versions/Minor-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 of the subscriptions in an order.
'
items:
type: string
type: array
subscriptions:
description: '**Note:** This field is in Zuora REST API version control. Supported minor versions are 223.0 or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-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.
'
items:
properties:
status:
description: Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action.
enum:
- Active
- Pending Activation
- Pending Acceptance
- Cancelled
type: string
subscriptionNumber:
description: Subscription number of the subscription included in this order.
type: string
type: object
type: array
type: object
description: "**Note:** The schema of the `result` nested field is the same as the response body schema of either the [\"Create an order\"](/api-references/api/operation/POST_Order) or the [\"Preview an order\"](/api-references/api/operation/POST_PreviewOrder) operation, depending on the purpose of the job.\n\nThe following schema for the nested `result` field is defined as the response body schema of \"Create an order\". See [Preview an Order](/api-references/api/operation/POST_PreviewOrder) for the response body schema of \"Preview an order\". \n"
PostOrderPreviewResponseType:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
previewResult:
$ref: '#/definitions/PreviewResult'
type: object
OrdersRatePlanObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Rate Plan or Subscription Offer object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, and the custom fields of the Subscription Offer object are used when product offers are subscribed.
'
title: ratePlanFieldsCustom
type: object
OrderLineItemCommonRetrieveOrder:
properties:
UOM:
description: 'Specifies the units to measure usage.
'
type: string
accountingCode:
description: 'The accounting code for the Order Line Item.
'
type: string
adjustmentLiabilityAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
adjustmentRevenueAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
amountPerUnit:
description: 'The actual charged amount per unit for the Order Line Item.
'
type: number
billTargetDate:
description: 'The target date for the Order Line Item to be picked up by bill run for billing.
'
format: date
type: string
billTo:
description: 'The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.
'
type: string
billToSnapshotId:
description: 'The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.
'
type: string
billingRule:
description: 'The billing rule of the Order Line Item.
'
enum:
- TriggerWithoutFulfillment
- TriggerAsFulfillmentOccurs
type: string
contractAssetAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
contractLiabilityAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
contractRecognizedRevenueAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
customFields:
$ref: '#/definitions/OrderLineItemCustomFields'
deferredRevenueAccountingCode:
description: 'The deferred revenue accounting code for the Order Line Item.
'
type: string
description:
description: 'The description of the Order Line Item.
'
type: string
discount:
description: 'This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.
The inline discount is applied to the list price of an order line item (see the `listPrice` field).
'
type: number
excludeItemBillingFromRevenueAccounting:
description: "The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
description: "The flag to exclude Order Line Item from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
type: boolean
inlineDiscountPerUnit:
description: 'This field is used in accordance with the `inlineDiscountType` field, in the following manner:
* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.
* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.
Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.
'
type: number
inlineDiscountType:
description: "This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
enum:
- Percentage
- FixedAmount
- None
type: string
invoiceOwnerAccountId:
description: 'The account ID of the invoice owner of the order line item.
'
type: string
invoiceOwnerAccountName:
description: 'The account name of the invoice owner of the order line item.
'
type: string
invoiceOwnerAccountNumber:
description: 'The account number of the invoice owner of the order line item.
'
type: string
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
itemCategory:
default: Sales
description: 'The category of the Order Line Item, to indicate a product sale or return.
'
enum:
- Sales
- Return
type: string
itemName:
description: 'The name of the Order Line Item.
'
type: string
itemState:
description: 'The state of an Order Line Item. See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.
'
enum:
- Executing
- Booked
- SentToBilling
- Complete
- Cancelled
type: string
itemType:
description: "The type of the Order Line Item. \n"
enum:
- Product
- Fee
- Services
type: string
listPrice:
description: 'The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity
'
type: number
listPricePerUnit:
description: 'The list price per unit for the Order Line Item.
'
type: number
originalOrderId:
description: "The ID of the original sale order for a return order line item. \n"
type: string
originalOrderLineItemId:
description: "The ID of the original sale order line item for a return order line item. \n"
type: string
originalOrderLineItemNumber:
description: "The number of the original sale order line item for a return order line item. \n"
type: string
originalOrderNumber:
description: "The number of the original sale order for a return order line item. \n"
type: string
ownerAccountId:
description: 'The account ID of the owner of the order line item.
'
type: string
ownerAccountName:
description: 'The account name of the owner of the order line item.
'
type: string
ownerAccountNumber:
description: 'The account number of the owner of the order line item.
'
type: string
productCode:
description: 'The product code for the Order Line Item.
'
type: string
productRatePlanChargeId:
description: 'Id of a Product Rate Plan Charge. Only one-time charges are supported.
'
type: string
purchaseOrderNumber:
description: 'Used by customers to specify the Purchase Order Number provided by the buyer.
'
type: string
quantity:
description: 'The quantity of units, such as the number of authors in a hosted wiki service.
'
type: number
quantityAvailableForReturn:
description: "The quantity that can be returned for an order line item. \n"
type: number
quantityFulfilled:
description: 'The fulfilled quantity for an order line item.
'
type: number
quantityPendingFulfillment:
description: "The quantity to fulfill for an order line item. \n"
type: number
recognizedRevenueAccountingCode:
description: 'The recognized revenue accounting code for the Order Line Item.
'
type: string
relatedSubscriptionNumber:
description: 'Use this field to relate an order line item to a subscription when you create the order line item.
* To relate an order line item to a new subscription which is yet to create in the same "Create an order" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the "Create order" operation. Specify this field to the same value as that of the ''subscriptions'' > `subscriptionNumber` field when you make the "Create order" call.
* To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.
'
type: string
requiresFulfillment:
description: 'The flag to show whether fulfillment is needed or not. It''s derived from billing rule of the Order Line Item.
'
type: boolean
revenueRecognitionRule:
description: 'The Revenue Recognition rule for the Order Line Item.
'
type: string
sequenceSetId:
description: 'The ID of the sequence set associated with the OrderLineItem.
'
type: string
soldTo:
description: 'The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.
'
type: string
soldToSnapshotId:
description: 'The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.
'
type: string
taxCode:
description: 'The tax code for the Order Line Item.
'
type: string
taxMode:
description: 'The tax mode for the Order Line Item.
'
enum:
- TaxInclusive
- TaxExclusive
type: string
transactionEndDate:
description: 'The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.
'
format: date
type: string
transactionStartDate:
description: 'The date a transaction starts. The default value of this field is the order date.
'
format: date
type: string
unbilledReceivablesAccountingCode:
description: 'The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
'
type: string
title: OrderLineItem
type: object
OneTimeTieredPricingOverride:
description: 'Pricing information about a one-time charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.
'
properties:
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
title: oneTimeTiered
type: object
TriggerParams:
description: 'Specifies when a charge becomes active.
'
properties:
periodsAfterChargeStart:
description: 'Duration of the discount charge in days, weeks, months, or years, depending on the value of the `startPeriodsType` field. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
type: integer
specificTriggerDate:
description: "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
format: date
type: string
startDatePolicy:
description: "Start date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation. \n\n- If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n- If the value of this field is `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\n**Notes**: \n - You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field. \n - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.\n"
enum:
- AlignToApplyToCharge
- SpecificDate
- EndOfLastInvoicePeriodOfApplyToCharge
- FixedPeriodAfterApplyToChargeStartDate
type: string
startPeriodsType:
description: 'Unit of time that the discount charge duration is measured in. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.
**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
'
enum:
- Days
- Weeks
- Months
- Years
type: string
triggerEvent:
description: 'Condition for the charge to become active.
If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.
'
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
- SpecificDate
type: string
title: startDate
type: object
RecurringFlatFeePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Price of the charge in each recurring period.
'
type: number
listPriceBase:
description: 'Specifies the duration of each recurring period.
'
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
priceIntervals:
description: "List of interval pricing in the charge. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
items:
$ref: '#/definitions/PriceIntervalWithPrice'
type: array
specificListPriceBase:
description: "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the Annual List Price feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
format: int32
maximum: 200
minimum: 1
type: integer
type: object
description: 'Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
'
title: recurringFlatFee
RampChargeResponse:
properties:
chargeNumber:
description: The number of the rate plan charge.
type: string
title: charges
type: object
OrderDeltaTcv:
allOf:
- $ref: '#/definitions/OrderDeltaMetric'
- properties:
orderLineItemId:
description: 'The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for subscriptions.
'
format: UUID
type: string
type: object
description: 'Order Delta Tcv. This is a metric that reflects the change to the TCV on Rate Plan Charge object, or the Total Contracted Value for an Order Line Item as the result of the order
'
type: object
ChangePlan:
description: 'Information about an order action of type `ChangePlan`.
**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.
'
properties:
effectivePolicy:
description: '* If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
* If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
* Otherwise, the effective policy is `SpecificDate` by default.
'
enum:
- EffectiveImmediately
- EffectiveEndOfBillingPeriod
- SpecificDate
type: string
newProductRatePlan:
$ref: '#/definitions/ChangePlanRatePlanOverride'
productRatePlanId:
description: 'ID of the rate plan to remove. This can be the latest version or any history version of ID.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
ratePlanId:
description: 'ID of the rate plan to remove. This can be the latest version or any history version of ID.
'
type: string
subType:
description: 'This field is used to choose the sub type for your change plan order action.
However, if you do not set this field, the field will be automatically generated by the system according to the following rules:
When the old and new rate plans are within the same Grading catalog group:
* If the grade of new plan is greater than that of the old plan, this is an "Upgrade".
* If the grade of new plan is less than that of the old plan, this is a "Downgrade".
* If the grade of new plan equals that of the old plan, this is a "Crossgrade".
When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged".
'
enum:
- Upgrade
- Downgrade
- Crossgrade
- PlanChanged
type: string
subscriptionRatePlanNumber:
description: 'Number of a rate plan for this subscription.
'
type: string
title: changePlan
type: object
TimeSlicedElpNetMetrics:
properties:
amount:
description: The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity.
type: number
endDate:
description: The latest date that the metric applies.
format: date
type: string
generatedReason:
description: 'Specify the reason why the metrics are generated by the certain order action.
'
enum:
- IncreaseQuantity
- DecreaseQuantity
- ChangePrice
- Extension
- Contraction
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the subscription.
type: string
orderItemId:
description: The ID of the order item referenced by the order metrics.
type: string
startDate:
description: The earliest date that the metric applies.
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
tax:
description: The tax amount in the metric when the tax permission is enabled.
type: number
termNumber:
format: long
type: number
type:
description: The type for ELP is always "Regular".
enum:
- Regular
- Discount
type: string
type: object
InvoiceItemPreviewResult:
properties:
additionalInfo:
properties:
numberOfDeliveries:
description: "The number of deliveries dedicated to the Delivery Pricing charges. \n\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
quantity:
type: number
unitOfMeasure:
type: string
type: object
amountWithoutTax:
type: number
appliedToChargeNumber:
description: 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.
type: string
chargeDescription:
type: string
chargeName:
type: string
chargeNumber:
description: Available when the chargeNumber was specified in the request or when the order is amending an existing subscription.
type: string
orderLineItemNumber:
description: A sequential number auto-assigned for each of order line items in a order, used as an index, for example, "1".
type: string
processingType:
enum:
- Charge
- Discount
- Tax
type: string
productName:
type: string
productRatePlanChargeId:
type: string
serviceEndDate:
format: date
type: string
serviceStartDate:
format: date
type: string
subscriptionNumber:
type: string
taxAmount:
type: number
taxationItems:
description: 'List of taxation items.
**Note**: This field is only available if you set the `zuora-version` request header to `309.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).
'
items:
properties:
exemptAmount:
description: 'The calculated tax amount excluded due to the exemption.
'
type: number
id:
description: 'The ID of the taxation item.
'
type: string
jurisdiction:
description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.
'
type: string
locationCode:
description: 'The identifier for the location based on the value of the taxCode field.
'
type: string
name:
description: 'The name of the taxation item.
'
type: string
taxAmount:
description: 'The amount of the tax applied to the invoice.
'
type: number
taxCode:
description: 'The tax code identifies which tax rules and tax rates to apply to a specific invoice.
'
type: string
taxCodeDescription:
description: 'The description of the tax code.
'
type: string
taxDate:
description: 'The date when the tax is applied to the invoice.
'
type: string
taxRate:
description: 'The tax rate applied to the invoice.
'
type: number
taxRateDescription:
description: 'The description of the tax rate.
'
type: string
taxRateType:
description: 'Enum:"Percentage" "FlatFee". The type of the tax rate applied to the invoice.
'
enum:
- Percentage
- FlatFee
type: string
type: object
type: array
unitPrice:
description: 'The per-unit price of the invoice item.
'
type: number
type: object
OfferOverride:
description: "Offer associated with a subscription. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
properties:
newSubscriptionOfferId:
description: 'Internal identifier of the subscription offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
type: string
newSubscriptionOfferNumber:
description: 'Number of the subscription offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
type: string
productOfferId:
description: 'Internal identifier of the offer that the subscription offer is based on.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
type: string
productOfferNumber:
description: 'Number of the offer that the subscription offer is based on.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
type: string
ratePlanOverrides:
description: 'List of rateplans associated with the offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
items:
$ref: '#/definitions/GetOfferRatePlanOverride'
type: array
subscriptionOfferUniqueToken:
description: 'Unique of the subscription offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
type: string
title: offer
type: object
subscribeToProduct:
allOf:
- $ref: '#/definitions/RatePlanOverride'
- $ref: '#/definitions/OfferOverride'
title: subscribeToProduct
type: object
CreateOrderProductOverride:
description: Information about the subscribed offer
properties:
productOfferId:
description: 'Internal identifier of the product offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
type: string
productOfferNumber:
description: 'Number of the product offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
maxLength: 100
type: string
ratePlanOverrides:
description: 'List of rate plans associated with this offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
items:
$ref: '#/definitions/CreateOfferRatePlanOverride'
type: array
subscriptionOfferUniqueToken:
description: 'Unique of the subscription offer.
**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
'
maxLength: 50
type: string
title: Offer
type: object
CreateOrderChargeUpdate:
description: 'The JSON object containing the information for a charge update in the ''UpdateProduct'' type order action.
'
properties:
billing:
$ref: '#/definitions/BillingUpdate'
chargeNumber:
description: 'The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
description:
type: string
effectiveDate:
$ref: '#/definitions/CreateOrderUpdateProductTriggerParams'
prepaidQuantity:
description: '**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).
'
type: number
pricing:
allOf:
- $ref: '#/definitions/CreateOrderPricingUpdate'
description: 'Pricing information about the charge.
'
uniqueToken:
description: 'A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.
'
type: string
type: object
CreateOrderOfferUpdate:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
ratePlanUpdates:
items:
$ref: '#/definitions/RatePlanUpdate'
type: array
subscriptionOfferId:
description: "Internal identifier of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
subscriptionOfferNumber:
description: "Number of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
maxLength: 100
type: string
subscriptionOfferUniqueToken:
description: "Unique identifier of the subscription offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.\n"
type: string
title: updateOffer
type: object
RecurringPerUnitPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
originalListPrice:
description: 'The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.
'
type: number
quantity:
minimum: 0
type: number
type: object
OrderObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Order object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of an Order object.
'
title: orderFieldsCustom
type: object
parameters:
GLOBAL_HEADER_Accept_Encoding:
name: Accept-Encoding
in: header
required: false
type: string
description: "Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n"
GLOBAL_REQUEST_pageSize:
name: pageSize
in: query
required: false
type: integer
maximum: 40
default: 20
description: 'The number of records returned per page in the response.
'
GLOBAL_REQUEST_page:
name: page
in: query
required: false
type: integer
minimum: 1
default: 1
description: 'The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
'
GLOBAL_HEADER_Content_Encoding:
name: Content-Encoding
in: header
required: false
type: string
description: 'Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
'
GLOBAL_HEADER_Zuora_Entity_Ids_Single:
name: Zuora-Entity-Ids
in: header
required: false
type: string
description: 'An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
'
GLOBAL_HEADER_Zuora_Org_Ids:
name: Zuora-Org-Ids
in: header
required: false
type: string
description: "Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.\n\nIf the header is not set, the operation is performed in scope of the user's accessible orgs.\n"
GLOBAL_HEADER_Idempotency_Key:
name: Idempotency-Key
in: header
required: false
type: string
maxLength: 255
description: "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. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"
GLOBAL_HEADER_Zuora_Track_Id:
name: Zuora-Track-Id
in: header
required: false
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora 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 (`"`), and quote (`''`).
'
GLOBAL_HEADER_Authorization_OAuth_optional:
name: Authorization
in: header
required: false
type: string
description: 'The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](/api-references/api/operation/createToken).
'
x-tagGroups:
- name: Authentication
tags:
- OAuth
- name: Products
tags:
- Products
- Catalog
- Catalog Groups
- Offers
- Price Book Items
- Product Rate Plans
- Product Rate Plan Definitions
- Product Rate Plan Charges
- Product Charge Definitions
- Product Rate Plan Charge Tiers
- Zuora Revenue Integration
- name: Customer Accounts
tags:
- Accounts
- Contacts
- Contact Snapshots
- name: Orders and Subscriptions
tags:
- Sign Up
- Orders
- Order Actions
- Order Line Items
- Fulfillments
- Ramps
- Subscriptions
- Rate Plans
- name: Advanced Consumption Billing
tags:
- Prepaid with Drawdown
- name: Usage
tags:
- Usage
- name: Billing Documents
tags:
- Delivery Adjustments
- Billing Documents
- Invoices
- Credit Memos
- Debit Memos
- E-Invoicing
- Invoice Schedules
- Taxation Items
- Sequence Sets
- Operations
- name: Bill Runs
tags:
- Bill Run
- Billing Preview Run
- name: Payment Methods
tags:
- Payment Methods
- Custom Payment Method Types
- Payment Method Updater
- Payment Method Snapshots
- Payment Method Transaction Logs
- Hosted Pages
- RSA Signatures
- name: Payments
tags:
- Payment Authorization
- Payment Gateways
- Payment Gateway Reconciliation
- Payments
- Payment Transaction Logs
- Payment Runs
- Payment Schedules
- Refunds
- name: Finance
tags:
- Accounting Codes
- Accounting Periods
- Summary Journal Entries
- Journal Runs
- Mass Updater
- name: Events and Notifications
tags:
- Notifications
- Custom Event Triggers
- Custom Scheduled Events
- name: Custom Objects
tags:
- Custom Object Definitions
- Custom Object Records
- Custom Object Jobs
- name: System Health
tags:
- API Health
- Bill Run Health
- Electronic Payments Health
- name: Workflow
tags:
- Workflows
- name: Data Query
tags:
- Data Queries
- name: AQuA
tags:
- Aggregate Queries
- name: Deployment Manager
tags:
- Configuration Templates
- name: Multiple Organizations
tags:
- Data Labeling
- name: Order to Revenue
tags:
- Regenerate
- name: General-Purpose Operations
tags:
- Actions
- Settings
- Files
- Imports
- Custom Exchange Rates
- Attachments
- Describe