swagger: '2.0'
info:
  version: '2023-12-15'
  title: API Reference Accounting Codes Payment Schedules API
  description: "\n\n# Introduction\n\nWelcome to the REST API reference for the Zuora Billing, Payments, and Central Platform!\n\nTo learn about the common use cases of Zuora REST APIs, check out the [REST API Tutorials](/rest-api/api-guides/overview/).\n\nIn addition to Zuora API Reference, we also provide API references for other Zuora products:\n\n  * [Revenue API Reference](/api-references/revenue/overview/)\n  * [Collections API Reference](/api-references/collections/overview/)\n    \nThe Zuora REST API provides a broad set of operations and resources that:\n\n  * Enable Web Storefront integration from your website.\n  * Support self-service subscriber sign-ups and account management.\n  * Process revenue schedules through custom revenue rule models.\n  * Enable manipulation of most objects in the Zuora Billing Object Model.\n\nWant to share your opinion on how our API works for you? <a href=\"https://community.zuora.com/t5/Developers/API-Feedback-Form/gpm-p/21399\" target=\"_blank\">Tell us how you feel </a>about using our API and what we can do to make it better.\n\nSome of our older APIs are no longer recommended but still available, not affecting any existing integration. To find related API documentation, see [Older API Reference](/api-references/older-api/overview/).\n\n\n## Access to the API\n\nIf you have a Zuora tenant, you can access the Zuora REST API via one of the following endpoints:\n\n| Tenant              | Base URL for REST Endpoints |\n|-------------------------|-------------------------|\n|US Cloud 1 Production | https://rest.na.zuora.com  |\n|US Cloud 1 API Sandbox |  https://rest.sandbox.na.zuora.com |\n|US Cloud 2 Production | https://rest.zuora.com |\n|US Cloud 2 API Sandbox | https://rest.apisandbox.zuora.com|\n|US Central Sandbox | https://rest.test.zuora.com |  \n|US Performance Test | https://rest.pt1.zuora.com |\n|US Production Copy | Submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a> to enable the Zuora REST API in your tenant and obtain the base URL for REST endpoints. See [REST endpoint base URL of Production Copy (Service) Environment for existing and new customers](https://community.zuora.com/t5/API/REST-endpoint-base-URL-of-Production-Copy-Service-Environment/td-p/29611) for more information. |\n|EU Production | https://rest.eu.zuora.com |\n|EU API Sandbox | https://rest.sandbox.eu.zuora.com |\n|EU Central Sandbox | https://rest.test.eu.zuora.com |\n\nThe Production endpoint provides access to your live user data. Sandbox tenants are a good place to test code without affecting real-world data. If you would like Zuora to provision a Sandbox tenant for you, contact your Zuora representative for assistance.\n\n\nIf you do not have a Zuora tenant, go to <a href=\"https://www.zuora.com/resource/zuora-test-drive\" target=\"_blank\">https://www.zuora.com/resource/zuora-test-drive</a> and sign up for a Production Test Drive tenant. The tenant comes with seed data, including a sample product catalog.\n\n\n# Error Handling\n\nIf a request to Zuora Billing REST API with an endpoint starting with `/v1` (except [Actions](/v1-api-reference/api/Actions) and CRUD operations) fails, the response will contain an eight-digit error code with a corresponding error message to indicate the details of the error.\n\nThe following code snippet is a sample error response that contains an error code and message pair:\n\n```\n {\n   \"success\": false,\n   \"processId\": \"CBCFED6580B4E076\",\n   \"reasons\":  [\n     {\n      \"code\": 53100320,\n      \"message\": \"'termType' value should be one of: TERMED, EVERGREEN\"\n     }\n    ]\n }\n```\nThe `success` field indicates whether the API request has succeeded. The `processId` field is a Zuora internal ID that you can provide to Zuora Global Support for troubleshooting purposes.\n\nThe `reasons` field contains the actual error code and message pair. The error code begins with `5` or `6` means that you encountered a certain issue that is specific to a REST API resource in Zuora Billing, Payments, and Central Platform. For example, `53100320` indicates that an invalid value is specified for the `termType` field of the `subscription` object.\n\nThe error code beginning with `9` usually indicates that an authentication-related issue occurred, and it can also indicate other unexpected errors depending on different cases. For example, `90000011` indicates that an invalid credential is provided in the request header. \n\nWhen troubleshooting the error, you can divide the error code into two components: REST API resource code and error category code. See the following Zuora error code sample:\n\n<a href=\"/ images/ZuoraErrorCode.jpeg\" target=\"_blank\"><img src=\"/ images/ZuoraErrorCode.jpeg\" alt=\"Zuora Error Code Sample\"></a>\n\n\n**Note:** Zuora determines resource codes based on the request payload. Therefore, if GET and DELETE requests that do not contain payloads fail, you will get `500000` as the resource code, which indicates an unknown object and an unknown field. \nThe error category code of these requests is valid and follows the rules described in the [Error Category Codes](/api-references/api/overview/#section/Error-Handling/Error-Category-Codes) section. \nIn such case, you can refer to the returned error message to troubleshoot.\n\n\n## REST API Resource Codes\n\nThe 6-digit resource code indicates the REST API resource, typically a field of a Zuora object, on which the issue occurs. In the preceding example, `531003` refers to the `termType` field of the `subscription` object. \n\nThe value range for all REST API resource codes is from `500000` to `679999`. See <a href=\"https://knowledgecenter.zuora.com/Central_Platform/API/AA_REST_API/Resource_Codes\" target=\"_blank\">Resource Codes</a> in the Knowledge Center for a full list of resource codes.\n\n## Error Category Codes\n\nThe 2-digit error category code identifies the type of error, for example, resource not found or missing required field. \n\nThe following table describes all error categories and the corresponding resolution:\n\n| Code    | Error category              | Description    | Resolution    |\n|:--------|:--------|:--------|:--------|\n| 10      | Permission or access denied | The request cannot be processed because a certain tenant or user permission is missing. | Check the missing tenant or user permission in the response message and contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> for enablement. |\n| 11      | Authentication failed       | Authentication fails due to invalid API authentication credentials. | Ensure that a valid API credential is specified. |\n| 20      | Invalid format or value     | The request cannot be processed due to an invalid field format or value. | Check the invalid field in the error message, and ensure that the format and value of all fields you passed in are valid. |\n| 21      | Unknown field in request    | The request cannot be processed because an unknown field exists in the request body. | Check the unknown field name in the response message, and ensure that you do not include any unknown field in the request body. |\n| 22      | Missing required field      | The request cannot be processed because a required field in the request body is missing. | Check the missing field name in the response message, and ensure that you include all required fields in the request body. |\n| 23      | Missing required parameter  | The request cannot be processed because a required query parameter is missing. | Check the missing parameter name in the response message, and ensure that you include the parameter in the query. |\n| 30      | Rule restriction            | The request cannot be processed due to the violation of a Zuora business rule. | Check the response message and ensure that the API request meets the specified business rules. |\n| 40      | Not found                   | The specified resource cannot be found. | Check the response message and ensure that the specified resource exists in your Zuora tenant. |\n| 45      | Unsupported request         | The requested endpoint does not support the specified HTTP method. | Check your request and ensure that the endpoint and method matches. |\n| 50      | Locking contention          | This request cannot be processed because the objects this request is trying to modify are being modified by another API request, UI operation, or batch job process. | <p>Resubmit the request first to have another try.</p> <p>If this error still occurs, contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> with the returned `Zuora-Request-Id` value in the response header for assistance.</p> |\n| 60      | Internal error              | The server encounters an internal error. | Contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> 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. | <p>Resubmit the request first to have another try.</p> <p>If this error still occurs, contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> with the returned `Zuora-Request-Id` value in the response header for assistance. </p>|\n| 70      | Request exceeded limit      | The total number of concurrent requests exceeds the limit allowed by the system. | <p>Resubmit the request after the number of seconds specified by the `Retry-After` value in the response header.</p> <p>Check [Concurrent request limits](/rest-api/general-concepts/rate-concurrency-limits/) for details about Zuora’s concurrent request limit policy.</p> |\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                                   | <p>`BillingRun` - API name used  in the [Describe](/api-references/api/operation/GET_Describe) operation, Export ZOQL queries, and Data Query.</p> <p>`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: Payment Schedules
  description: 'Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments.

    For more information about payment schedules, see <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/A_Payment_Schedules_overview" target="_blank">Payment Schedules</a>.

    '
paths:
  /v1/payment-schedules:
    post:
      description: 'Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules.


        **Note:**

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        - You can choose to use payment schedules to process payments associated with billing documents or unapplied payments. If Standalone Payment is enabled, you can also use payment schedules to process standalone payments.

        - This operation is version controlled. If you set `zuora-version` to `329.0`, when creating custom payment schedules associated with billing documents, you need to specify the billing document for each payment schedule item; If `zuora-version` is set to `330.0`, when creating custom payment schedules associated with billing documents, you only need to specify the billing documents at the payment schedule level. The default version number is `329.0`. However, we recommend that you specify the version to `330.0`. `329.0` will be deprecated soon.

        '
      summary: Create a payment schedule
      operationId: POST_PaymentSchedule
      tags:
      - Payment Schedules
      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'
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/POSTPaymentScheduleRequest'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following request fields:\n* `billingDocument`\n* `items` > `billingDocument`\n"
      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
              id: 402880e749b72b310149b7343ef80005
              paymentScheduleNumber: PS-00000001
              accountId: 402880e741112b310149b7343ef81234
              accountNumber: A-00000001
              startDate: '2021-11-01'
              period: Monthly
              runHour: 1
              occurrences: 2
              totalAmount: 20
              status: Active
              nextProcessDate: '2021-11-01'
              recentProcessedDate: null
              processedCount: 0
              errorCount: 0
              description: null
              “isCustom”: true
              “standalone”: true
              cf1__c: v1
              createdDate: '2021-11-01 19:40:00'
              updatedDate: '2021-11-01 19:40:00'
              createdById: 402892f942306295014230a4ab4909bf
              updatedById: 402892f942306295014230a4ab4909bf
              items:
              - id: 412880e749b72b310149b7343ef81346
                number: 1
                paymentScheduleId: 402880e749b72b310149b7343ef80005
                paymentScheduleNumber: PS-00000001
                accountId: 402880e741112b310149b7343ef81234
                scheduledDate: '2021-11-01'
                amount: 10
                currency: USD
                runHour: 1
                paymentMethodId: '123'
                paymentGatewayId: abc
                status: Pending
                errorMessage: null
                paymentId: null
                standalone: true
                description: null
                cf1__c: v1
                createdDate: '2021-11-01 19:40:00'
                updatedDate: '2021-11-01 19:40:00'
                createdById: 402892f942306295014230a4ab4909bf
                updatedById: 402892f942306295014230a4ab4909bf
                billingDocument:
                  number: INV00002345
                  id: 2c9890306fb2121e016fb21a6b550041
                  type: Invoice
              - id: 412880e749b72b310149b7343ef81347
                number: 1
                paymentScheduleId: string
                paymentScheduleNumber: string
                accountId: 402880e741112b310149b7343ef81234
                scheduledDate: '2021-12-01'
                amount: 10
                currency: USD
                runHour: 1
                paymentMethodId: '123'
                paymentGatewayId: abc
                standalone: true
                status: Pending
                errorMessage: null
                paymentId: null
                description: null
                cf1__c: v1
                createdDate: '2021-11-01 19:40:00'
                updatedDate: '2021-11-01 19:40:00'
                createdById: 402892f942306295014230a4ab4909bf
                updatedById: 402892f942306295014230a4ab4909bf
                billingDocument:
                  number: INV00007765
                  id: 2c9890306f6fb21a6b550041b2121e01
                  type: Invoice
          schema:
            $ref: '#/definitions/POSTPaymentScheduleResponse'
    get:
      description: 'Retrieves payment schedules of a customer account.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: List payment schedules by customer account
      operationId: GET_PaymentSchedules
      tags:
      - Payment Schedules
      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: lastProcessedItems
        in: query
        description: 'Number of the most recent processed payment schedules dispalyed in the response body.

          '
        required: false
        type: integer
      - name: nextPendingItems
        in: query
        description: 'Number of next pending payment schedule items displayed in the response body.

          '
        required: false
        type: integer
      - name: accountId
        in: query
        description: "The ID of the customer account. If neither `accountId` nor `accountNumber` is specified, all payment schedules will be returned. \n"
        required: false
        type: string
      - name: accountNumber
        in: query
        description: "The number of the customer account. If neither `accountId` nor `accountNumber` is specified, all payment schedules will be returned. \n"
        required: false
        type: integer
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following fields:\n* `items` > `paymentId`          \n"
      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:
            - id: 8a90857b822459cd018224dcb9eb13be
              paymentScheduleNumber: PS-00000007
              standalone: false
              accountId: 8a90a2fd8074995801807816dbac52a4
              accountNumber: A00000002
              startDate: '2022-07-31'
              runHour: 0
              period: null
              occurrences: 2
              totalAmount: 50
              status: Active
              nextPaymentDate: '2022-07-31'
              recentPaymentDate: null
              totalPaymentsProcessed: 0
              totalPaymentsErrored: 0
              description: ''
              isCustom: true
              billingDocument: null
              createdDate: '2022-07-22 00:43:42'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-22 00:45:36'
              updatedById: 8a90e082802185b901802199e15902d1
              items:
              - id: 8a90857b822459cd018224dcb9ec13bf
                number: 1
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2022-07-31'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 30.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: ''
                createdDate: '2022-07-22 00:43:42'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-22 00:43:42'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90a2fd822459ec018224de77a0359d
                number: 2
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2022-08-31'
                runHour: 20
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: ''
                createdDate: '2022-07-22 00:45:35'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-22 00:45:35'
                updatedById: 8a90e082802185b901802199e15902d1
            - id: 8a90e0828219a57101821f00287a3abd
              paymentScheduleNumber: PS-00000006
              standalone: false
              accountId: 8a90a2fd8074995801807816dbac52a4
              accountNumber: A00000002
              startDate: '2022-07-21'
              runHour: 11
              period: BiWeekly
              occurrences: 4
              totalAmount: 40
              status: Active
              nextPaymentDate: '2022-08-04'
              recentPaymentDate: '2022-07-21'
              totalPaymentsProcessed: 1
              totalPaymentsErrored: 0
              description: test update ps Xiaokai
              isCustom: false
              billingDocument: null
              createdDate: '2022-07-20 21:24:40'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-21 11:00:21'
              updatedById: '3'
              items:
              - id: 8a90e0828219a57101821f00287a3abf
                number: 1
                paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                paymentScheduleNumber: PS-00000006
                standalone: false
                scheduledDate: '2022-07-21'
                runHour: 11
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Processed
                errorMessage: null
                paymentId: 8a90e86d821fd6d1018221eae795158b
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: test update ps
                createdDate: '2022-07-20 21:24:40'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-21 11:00:19'
                updatedById: '3'
              - id: 8a90e0828219a57101821f00287b3ac0
                number: 2
                paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                paymentScheduleNumber: PS-00000006
                standalone: false
                scheduledDate: '2022-08-04'
                runHour: 11
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: test update ps
                createdDate: '2022-07-20 21:24:40'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-20 21:26:26'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e0828219a57101821f00287b3ac1
                number: 3
                paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                paymentScheduleNumber: PS-00000006
                standalone: false
                scheduledDate: '2022-08-18'
                runHour: 11
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: test update ps
                createdDate: '2022-07-20 21:24:40'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-20 21:26:26'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e0828219a57101821f01c5447f04
                number: 4
                paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                paymentScheduleNumber: PS-00000006
                standalone: false
                scheduledDate: '2022-09-01'
                runHour: 11
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: test update ps
                createdDate: '2022-07-20 21:26:26'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-20 21:26:26'
                updatedById: 8a90e082802185b901802199e15902d1
          schema:
            $ref: '#/definitions/GETPaymentSchedulesResponse'
  /v1/payment-schedules/batch:
    post:
      description: 'Creates multiple payment schedules at once. You can create both recurring payment schedules and custom payment schedules in one request. The maximum number of payment schedules that can be created by a single request is 50. The maximum number of payment schedule items that each payment schedule can contain is 1000, i.e., you must specify less than 1000 items for a custom payment schedule, and the `occurrences` field must be less than 1000 for a recurring payment schedule.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        - If Standalone Payment is enabled, you can choose to use payment schedules to process payments associated with billing documents, standalone payments, or unapplied payments. If Standalone Payment is not enabled, you can only use payment schedules to process unapplied payments or payments associated with billing documents.

        - This operation is version controlled. If you set `zuora-version` to `329.0`, when creating custom payment schedules associated with billing documents, you need to specify the billing document for each payment schedule item; If `zuora-version` is set to `330.0`, when creating custom payment schedules associated with billing documents, you only need to specify the billing documents at the payment schedule level. The default version number is `329.0`. However, we recommend that you specify the version to `330.0`. `329.0` will be deprecated soon.

        '
      summary: Create multiple payment schedules at once
      operationId: POST_PaymentSchedules
      tags:
      - Payment Schedules
      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'
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/POSTPaymentSchedulesRequest'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following request fields:\n* `paymentSchedules` > `billingDocument`\n* `paymentSchedules` > `items` > `billingDocument`\n"
      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:
              paymentSchedules:
              - id: 402880e741112b310149b7343ef81234
                paymentScheduleNumber: PS-00311401
              - id: 402880e741112b310149b7343ef81234
                paymentScheduleNumber: PS-00311402
          schema:
            $ref: '#/definitions/POSTPaymentSchedulesResponse'
  /v1/payment-schedules/{paymentScheduleKey}:
    get:
      description: 'Retrieves a payment schedule by payment schedule key.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Retrieve a payment schedule
      operationId: GET_PaymentSchedule
      tags:
      - Payment Schedules
      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:
              id: 8a90857b822459cd018224dcb9eb13be
              paymentScheduleNumber: PS-00000007
              standalone: false
              accountId: 8a90a2fd8074995801807816dbac52a4
              accountNumber: A00000002
              startDate: '2022-07-31'
              runHour: 0
              period: null
              occurrences: 2
              totalAmount: 40
              status: Active
              nextPaymentDate: '2022-07-31'
              recentPaymentDate: null
              totalPaymentsProcessed: 0
              totalPaymentsErrored: 0
              description: ''
              isCustom: true
              billingDocument:
                id: 8a90a2fd819503b50181959525e5205d
                number: INV00000001
                type: Invoice
              createdDate: '2022-07-22 00:43:42'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-22 00:45:36'
              updatedById: 8a90e082802185b901802199e15902d1
              items:
              - id: 8a90857b822459cd018224dcb9ec13bf
                number: 1
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2022-07-31'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 30.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: ''
                createdDate: '2022-07-22 00:43:42'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-22 00:43:42'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90a2fd822459ec018224de77a0359d
                number: 2
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2022-08-31'
                runHour: 20
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: ''
                createdDate: '2022-07-22 00:45:35'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-22 00:45:35'
                updatedById: 8a90e082802185b901802199e15902d1
              success: true
          schema:
            $ref: '#/definitions/GETPaymentScheduleResponse'
      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: nextPendingItems
        in: query
        description: 'Number of next pending payment schedule items displayed in the response body.

          '
        required: false
        type: integer
      - name: lastProcessedItems
        in: query
        description: 'Number of the most recent processed payment schedule items dispalyed in the response body.

          '
        required: false
        type: integer
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n  - `items` > `paymentId`\n"
      - type: string
        in: path
        name: paymentScheduleKey
        required: true
        description: 'The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.

          '
    put:
      description: 'Updates a payment schedule. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the [Update a payment schedule item](/api-references/api/operation/PUT_PaymentScheduleItem/) operation to update payment schedule items of custom payment schedule.


        Note the following rules for the `periodStartDate`, `period`, and `occurrences`:


        - If `periodStartDate` is specified, all pending payment schedule items will be rescheduled using this new `periodStartDate`. If `period` is changed, we recommend passing in `periodStartDate`. Otherwise, the system would use the original start date if there is no processed or canceled items, or the last processed or canceled ''`scheduleDate` + 1 `period`'' as the new `periodStartDate`.

        - If only `occurrences` is updated, the new item will start with the last processed or canceled ''`scheduleDate` + 1 `period`''.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Update a payment schedule
      operationId: PUT_PaymentSchedule
      tags:
      - Payment Schedules
      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'
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PUTPaymentScheduleRequest'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following fields:\n- `items` > `paymentId`\n"
      - type: string
        in: path
        name: paymentScheduleKey
        required: true
        description: 'The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.

          '
      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:
              id: 8a90e08281e10bb00181e749f4db01b8
              paymentScheduleNumber: PS-00000002
              standalone: true
              accountId: 8a90a2fd8074995801807816dbac52a4
              accountNumber: A00000002
              startDate: '2022-07-10'
              runHour: 23
              period: Monthly
              occurrences: 5
              totalAmount: 230
              status: Active
              nextPaymentDate: '2022-11-01'
              recentPaymentDate: null
              totalPaymentsProcessed: 0
              totalPaymentsErrored: 0
              description: test xiaokai
              isCustom: false
              billingDocument: null
              createdDate: '2022-07-10 01:46:33'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-28 06:12:39'
              updatedById: 8a90e082802185b901802199e15902d1
              items:
              - id: 8a90e08281e10bb00181e749f4dd01b9
                number: 1
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-07-10'
                runHour: 12
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 100.0
                currency: USD
                status: Canceled
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-10 01:46:33'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e08281e10bb00181e749f4e501ba
                number: 2
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-08-10'
                runHour: 12
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 100.0
                currency: USD
                status: Canceled
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-10 01:46:33'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e08281e10bb00181e749f4e601bb
                number: 3
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-11-01'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-10 01:46:33'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a908de6822b2e1501823352ac745b53
                number: 4
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-12-01'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-24 20:07:12'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e082824456ae018244f00e0317eb
                number: 5
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2023-01-01'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-28 06:12:39'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e159021d
              success: true
          schema:
            $ref: '#/definitions/GETPaymentScheduleResponse'
  /v1/payment-schedules/{paymentScheduleKey}/preview:
    put:
      description: 'Preview the result of a payment schedule update. This operation only provides a preview. No changes will be made to the database. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the [Update a payment schedule item](/v1-api-reference/api/PUT_PaymentScheduleItem) operation to update payment schedule items of custom payment schedule.


        Note the following rules for the `periodStartDate`, `period`, and `occurrences`:


        - If `periodStartDate` is specified, all pending payment schedule items will be rescheduled using this new `periodStartDate`. If `period` is changed, we recommend passing in `periodStartDate`. Otherwise, the system would use the original start date if there is no processed or canceled items, or the last processed or canceled ''`scheduleDate` + 1 `period`'' as the new `periodStartDate`.

        - If only `occurrences` is updated, the new item will start with the last processed or canceled ''`scheduleDate` + 1 `period`''.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        '
      summary: Preview the result of payment schedule updates
      operationId: PUT_PaymentScheduleUpdatePreview
      tags:
      - Payment Schedules
      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'
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PUTPreviewPaymentScheduleRequest'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following fields:\n- `items` > `paymentId`\n"
      - type: string
        in: path
        name: paymentScheduleKey
        required: true
        description: 'The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.

          '
      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:
              id: 8a90e08281e10bb00181e749f4db01b8
              paymentScheduleNumber: PS-00000002
              standalone: true
              accountId: 8a90a2fd8074995801807816dbac52a4
              accountNumber: A00000002
              startDate: '2022-07-10'
              runHour: 23
              period: Monthly
              occurrences: 5
              status: Active
              nextPaymentDate: '2022-11-01'
              recentPaymentDate: null
              totalPaymentsProcessed: 0
              totalPaymentsErrored: 0
              description: test xiaokai
              isCustom: false
              billingDocument: null
              createdDate: '2022-07-10 01:46:33'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-28 06:12:39'
              updatedById: 8a90e082802185b901802199e15902d1
              items:
              - id: 8a90e08281e10bb00181e749f4dd01b9
                number: 1
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-07-10'
                runHour: 12
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 100.0
                currency: USD
                status: Canceled
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-10 01:46:33'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e08281e10bb00181e749f4e501ba
                number: 2
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-08-10'
                runHour: 12
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 100.0
                currency: USD
                status: Canceled
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-10 01:46:33'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e08281e10bb00181e749f4e601bb
                number: 3
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-11-01'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-10 01:46:33'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a908de6822b2e1501823352ac745b53
                number: 4
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2022-12-01'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-24 20:07:12'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e082824456ae018244f00e0317eb
                number: 5
                paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                paymentScheduleNumber: PS-00000002
                standalone: true
                scheduledDate: '2023-01-01'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument: null
                description: test xiaokai
                createdDate: '2022-07-28 06:12:39'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 06:12:39'
                updatedById: 8a90e082802185b901802199e15902d1
              success: true
          schema:
            $ref: '#/definitions/GETPaymentScheduleResponse'
  /v1/payment-schedules/{paymentScheduleKey}/cancel:
    put:
      description: "Cancels a payment schedule.\n\n**Note:**\n- All pending payment schedule items will be canceled, effective from `cancelDate`. \n- The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.\n"
      summary: Cancel a payment schedule
      operationId: PUT_CancelPaymentSchedule
      tags:
      - Payment Schedules
      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
              id: 402880e749b72b310149b7343ef80005
              paymentScheduleNumber: PS-00000001
              accountId: 402880e741112b310149b7343ef81234
              accountNumber: A-00000001
              startDate: '2021-11-01'
              period: Monthly
              runHour: 1
              occurrences: 2
              totalAmount: 20
              status: Canceled
              nextProcessDate: '2021-11-01'
              recentProcessedDate: null
              processedCount: 0
              errorCount: 0
              description: null
              cf1__c: v1
              createdDate: '2021-11-01 19:40:00'
              updatedDate: '2021-11-01 19:40:00'
              createdById: 402892f942306295014230a4ab4909bf
              updatedById: 402892f942306295014230a4ab4909bf
              items:
              - id: 412880e749b72b310149b7343ef81346
                number: 1
                paymentScheduleId: string
                paymentScheduleNumber: string
                accountId: 402880e741112b310149b7343ef81234
                scheduledDate: '2021-11-01'
                amount: 10
                currency: USD
                runHour: 1
                paymentMethodId: '123'
                paymentGatewayId: abc
                status: Canceled
                errorMessage: null
                paymentId: null
                description: null
                cf1__c: v1
                createdDate: '2021-11-01 19:40:00'
                updatedDate: '2021-11-01 19:40:00'
                createdById: 402892f942306295014230a4ab4909bf
                updatedById: 402892f942306295014230a4ab4909bf
              - id: 412880e749b72b310149b7343ef81347
                number: 2
                paymentScheduleId: string
                paymentScheduleNumber: string
                accountId: 402880e741112b310149b7343ef81234
                scheduledDate: '2021-12-01'
                amount: 10
                currency: USD
                runHour: 1
                paymentMethodId: '123'
                paymentGatewayId: abc
                status: Canceled
                errorMessage: null
                paymentId: null
                description: null
                cf1__c: v1
                createdDate: '2021-11-01 19:40:00'
                updatedDate: '2021-11-01 19:40:00'
                createdById: 402892f942306295014230a4ab4909bf
                updatedById: 402892f942306295014230a4ab4909bf
          schema:
            $ref: '#/definitions/GETPaymentScheduleResponse'
      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'
      - type: string
        in: path
        name: paymentScheduleKey
        required: true
        description: 'The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.

          '
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the followiing response fields:\n  - `items` > `paymentId`\n"
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PUTCancelPaymentScheduleRequest'
  /v1/payment-schedules/{paymentScheduleKey}/items:
    post:
      description: 'Adds payment schedule items to a custom payment schedule. You cannot use this operation to add payment schedule items to recurring payment schedules.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Add payment schedule items to a custom payment schedule
      operationId: POST_AddItemsToCustomPaymentSchedule
      tags:
      - Payment Schedules
      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'
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/POSTAddItemsToPaymentScheduleRequest'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following fields:\n- `items` > `paymentId`\n"
      - type: string
        in: path
        name: paymentScheduleKey
        required: true
        description: 'The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.

          '
      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:
              id: 8a90857b822459cd018224dcb9eb13be
              paymentScheduleNumber: PS-00000007
              standalone: false
              accountId: 8a90a2fd8074995801807816dbac52a4
              accountNumber: A00000002
              startDate: '2022-07-31'
              runHour: 0
              period: null
              occurrences: 3
              totalAmount: 50
              status: Active
              nextPaymentDate: '2022-07-31'
              recentPaymentDate: null
              totalPaymentsProcessed: 0
              totalPaymentsErrored: 0
              description: ''
              isCustom: true
              billingDocument: null
              createdDate: '2022-07-22 00:43:42'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-28 23:15:23'
              updatedById: 8a90e082802185b901802199e15902d1
              items:
              - id: 8a90857b822459cd018224dcb9ec13bf
                number: 1
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2022-07-31'
                runHour: 23
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 30.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: ''
                createdDate: '2022-07-22 00:43:42'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-22 00:43:42'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90a2fd822459ec018224de77a0359d
                number: 2
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2022-08-31'
                runHour: 20
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: ''
                createdDate: '2022-07-22 00:45:35'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-22 00:45:35'
                updatedById: 8a90e082802185b901802199e15902d1
              - id: 8a90e082824507750182489868257126
                number: 3
                paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                paymentScheduleNumber: PS-00000007
                standalone: false
                scheduledDate: '2023-01-01'
                runHour: 1
                paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                paymentGatewayId: 8a90a2fd807499580180781775c452a8
                amount: 10.0
                currency: USD
                status: Pending
                errorMessage: null
                paymentId: null
                billingDocument:
                  id: 8a90a2fd819503b50181959525e5205d
                  number: INV00000001
                  type: Invoice
                description: test test
                createdDate: '2022-07-28 23:15:23'
                createdById: 8a90e082802185b901802199e15902d1
                updatedDate: '2022-07-28 23:15:23'
                updatedById: 8a90e082802185b901802199e15902d1
              success: true
          schema:
            $ref: '#/definitions/GETPaymentScheduleResponse'
  /v1/payment-schedules/statistics/{yyyy-mm-dd}:
    get:
      description: 'Retrieves the payment schedule statistic of a specific date.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        '
      summary: Retrieve payment schedule statistic of a date
      operationId: GET_PaymentScheduleStatistic
      tags:
      - Payment Schedules
      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:
              date: '2022-07-29'
              paymentScheduleItems:
                pending: 0
                processed: 0
                error: 0
              paymentRuns: []
              success: true
          schema:
            $ref: '#/definitions/GETPaymentScheduleStatisticResponse'
      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'
      - type: string
        format: date
        in: path
        name: yyyy-mm-dd
        required: true
        description: "Specifies the date of the payment schedule statistic you want to view. \n"
  /v1/payment-schedule-items/{item-id}:
    get:
      description: 'Retrieves a payment schedule item by ID.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Retrieve a payment schedule item
      operationId: GET_PaymentScheduleItem
      tags:
      - Payment Schedules
      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:
              id: 8a90857b822459cd018224dcb9ec13bf
              number: 1
              paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
              paymentScheduleNumber: PS-00000007
              standalone: false
              scheduledDate: '2022-07-31'
              runHour: 23
              paymentMethodId: 8a90a2fd8074995801807817ebed52aa
              paymentGatewayId: 8a90a2fd807499580180781775c452a8
              amount: 30.0
              currency: USD
              status: Pending
              errorMessage: null
              paymentId: null
              billingDocument:
                id: 8a90a2fd819503b50181959525e5205d
                number: INV00000001
                type: Invoice
              description: ''
              createdDate: '2022-07-22 00:43:42'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-22 00:43:42'
              updatedById: 8a90e082802185b901802199e15902d1
              success: true
          schema:
            $ref: '#/definitions/GETPaymentScheduleItemResponse'
      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: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n- `paymentId`\n"
      - type: string
        in: path
        name: item-id
        required: true
        description: 'The unique ID of a payment schedule item.

          '
    put:
      description: "Updates a payment schedule item by ID.\n\n**Note:**\n- The Payment Schedules 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 manag](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features).\n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.\n- To link a single payment to the payment schedule item, specify the `paymentID` field in the request body and set `zuora-version` to equal to or smaller than `336.0`; To link or unlink multiple payments with the item, specify the `linkPayments` and `unlinkPayments` field in the request body. \n- The maximum number of payments that are allowed to be linked to a payment schedule item is `10`.\n- When unlinking and linking payments with the payment schedule item in one request, Zuora will first unlink the linked payments, and then link new payments to the item.\n"
      summary: Update a payment schedule item
      operationId: PUT_PaymentScheduleItem
      tags:
      - Payment Schedules
      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:
              id: 8a90857b822459cd018224dcb9ec13bf
              number: 1
              paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
              paymentScheduleNumber: PS-00000007
              standalone: false
              scheduledDate: '2022-07-31'
              runHour: 23
              paymentMethodId: 8a90a2fd8074995801807817ebed52aa
              paymentGatewayId: 8a90a2fd807499580180781775c452a8
              amount: 30.0
              currency: USD
              status: Pending
              errorMessage: null
              paymentId: null
              billingDocument:
                id: 8a90a2fd819503b50181959525e5205d
                number: INV00000001
                type: Invoice
              description: ''
              cancellationReason: null
              createdDate: '2022-07-22 00:43:42'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-22 00:43:42'
              updatedById: 8a90e082802185b901802199e15902d1
              success: true
          schema:
            $ref: '#/definitions/PUTPaymentScheduleItemResponse'
      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'
      - type: string
        in: path
        name: item-id
        required: true
        description: 'The unique ID of a payment schedule item.

          '
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PUTPaymentScheduleItemRequest'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following request fields:\n* `paymentId`\n* `linkPayments`\n* `unlinkPayments`\n\nThis header affects the availability of the following response fields:\n* `paymentId`            \n"
  /v1/payment-schedule-items/{item-id}/cancel:
    put:
      description: 'Cancels a payment schedule item by ID.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Cancel a payment schedule item
      operationId: PUT_CancelPaymentScheduleItem
      tags:
      - Payment Schedules
      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:
              id: 8a90857b822459cd018224dcb9ec13bf
              number: 1
              paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
              paymentScheduleNumber: PS-00000007
              standalone: false
              scheduledDate: '2022-11-01'
              runHour: 23
              paymentMethodId: 8a90a2fd8074995801807817ebed52aa
              paymentGatewayId: 8a90a2fd807499580180781775c452a8
              amount: 30.0
              currency: USD
              status: Canceled
              errorMessage: null
              paymentId: null
              billingDocument:
                id: 8a90a2fd819503b50181959525e5205d
                number: INV00000001
                type: Invoice
              description: ''
              cancellationReason: Skip Payment
              createdDate: '2022-07-22 00:43:42'
              createdById: 8a90e082802185b901802199e15902d1
              updatedDate: '2022-07-29 02:54:54'
              updatedById: 8a90e082802185b901802199e15902d1
              success: true
          schema:
            $ref: '#/definitions/PUTPaymentScheduleItemResponse'
      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: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n- `paymentId`\n"
      - type: string
        in: path
        name: item-id
        required: true
        description: "The unique ID of a payment schedule item.     \n"
  /v1/payment-schedule-items/{item-id}/skip:
    put:
      description: 'Skips a payment schedule item by ID. The skipped payment schedule item will turn to the `canceled` status, and a new item will be scheduled on the next recurring date after the last existing scheduled date.


        **Note:**

        - Only payment schedule items in recurring payment schedules can be skipped, and the item must be in the `pending` status.

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Skip a payment schedule item
      operationId: PUT_SkipPaymentScheduleItem
      tags:
      - Payment Schedules
      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:
              id: 402881a683642cff018364354abf12b6
              number: 7
              paymentScheduleId: 402881a68361af72018361d4be120047
              paymentScheduleNumber: PS-00000004
              standalone: true
              scheduledDate: '2022-11-04'
              runHour: 3
              paymentMethodId: 402892f9423062950142306f326c0056
              paymentGatewayId: null
              amount: 30.0
              currency: USD
              status: Pending
              errorMessage: null
              paymentId: null
              billingDocument: null
              description: ''
              cf1__c: null
              cf2__c: null
              cancellationReason: Skip Payment
              createdDate: '2022-09-22 00:59:17'
              createdById: 402892f9423062950142306f2f530002
              updatedDate: '2022-09-22 00:59:17'
              updatedById: 402892f9423062950142306f2f530002
              success: true
          schema:
            $ref: '#/definitions/PUTSkipPaymentScheduleItemResponse'
      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: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n- `paymentId`\n"
      - type: string
        in: path
        name: item-id
        required: true
        description: "The unique ID of a payment schedule item.   \n"
  /v1/payment-schedule-items/retry-payment:
    post:
      description: 'Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry.


        Note that you can retry a payment schedule item only when the payment schedule item is either in the `Error` or `Pending` status.


        **Note:**

        - The Payment Schedules 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 this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.

        - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled.

        '
      summary: Retry failed payment schedule items
      operationId: POST_RetryPaymentScheduleItem
      tags:
      - Payment Schedules
      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:
              items:
              - id: 402882e97f24bc36017f2986654f0253
                paymentScheduleId: string
                paymentScheduleNumber: string
                scheduledDate: null
                runHour: null
                paymentMethodId: null
                paymentGatewayId: null
                amount: null
                currency: null
                status: null
                errorMessage: Can not retry because payment Processed status is not allowed.
                paymentId: null
                description: null
                createdDate: null
                createdById: null
                updatedDate: null
                updatedById: null
              - id: 402882e97f24bc36017f298665570254
                paymentScheduleId: string
                paymentScheduleNumber: string
                scheduledDate: '2022-02-22'
                runHour: 0
                paymentMethodId: 402882e97f24bc36017f258c2ff20076
                paymentGatewayId: 402883827d097a28017d09b41f690261
                amount: 2.0
                currency: USD
                status: Processed
                errorMessage: null
                paymentId: 402882e97f24bc36017f298efb360277
                description: null
                PSIPaymentDate__c: '2022-02-22'
                PSIPicklist__c: '1'
                PSIPaymentPicklist__c: '1'
                PSIPaymentText__c: Payment Text From PSI via API Payment Error
                PSIText__c: PSI Text Value
                createdDate: '2022-02-23 18:19:07'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2022-02-23 18:28:30'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/POSTRetryPaymentScheduleItemResponse'
      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: zuora-version
        in: header
        required: false
        type: string
        description: "The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n- `items` > `paymentId`\n"
      - in: body
        name: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/POSTRetryPaymentScheduleItemRequest'
definitions:
  GETPaymentScheduleResponse:
    allOf:
    - properties:
        accountId:
          description: 'ID of the account that owns the payment schedule.

            '
          type: string
        accountNumber:
          description: 'Number of the account that owns the payment schedule.

            '
          type: string
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'The number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        createdById:
          description: 'The ID of the user who created this payment schedule.

            '
          type: string
        createdDate:
          description: 'The date and time the payment schedule is created.

            '
          format: date
          type: string
        description:
          description: 'The description of the payment schedule.

            '
          type: string
        id:
          description: 'ID of the payment schedule.

            '
          type: string
        isCustom:
          description: 'Indicates if the payment schedule is a custom payment schedule.

            '
          type: boolean
        items:
          description: 'Container for payment schedule items.

            '
          items:
            $ref: '#/definitions/PaymentScheduleItemCommonResponse'
          type: array
        nextPaymentDate:
          description: 'The date the next payment will be processed.

            '
          format: date
          type: string
        occurrences:
          description: 'The number of payment schedule items that are created by this payment schedule.

            '
          type: integer
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleNumber:
          description: 'Number of the payment schedule.

            '
          type: string
        period:
          description: 'For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.


            Return `null` for custom payment schedules.

            '
          type: string
        prepayment:
          description: 'Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        recentPaymentDate:
          description: 'The date the last payment was processed.

            '
          format: date
          type: string
        runHour:
          description: '[0,1,2,~,22,23]


            At which hour in the day in the tenant’s timezone this payment will be collected.


            Return `0` for custom payment schedules.

            '
          type: integer
        standalone:
          description: 'Indicates if the payments that the payment schedule created are standalone payments.

            '
          type: boolean
        startDate:
          description: 'The date when the first payment of this payment schedule is proccessed.

            '
          format: date
          type: string
        status:
          description: 'The status of the payment schedule.


            - Active: There is still payment schedule item to process.

            - Canceled: After a payment schedule is canceled by the user, the schedule is marked as `Canceled`.

            - Completed: After all payment schedule items are processed, the schedule is marked as `Completed`.

            '
          enum:
          - Active
          - Canceled
          - Completed
          type: string
        success:
          description: "Returns `true` if the request was processed successfully.        \n"
          type: boolean
        totalAmount:
          description: 'The total amount that will be collected by the payment schedule.

            '
          type: number
        totalPaymentsErrored:
          description: 'The number of errored payments.

            '
          type: integer
        totalPaymentsProcessed:
          description: 'The number of processed payments.

            '
          type: integer
        updatedById:
          description: 'The ID of the user who last updated this payment schedule.

            '
          type: string
        updatedDate:
          description: 'The date and time the payment schedule is last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleCustomFields'
  GETPaymentSchedulesResponse:
    description: 'Container for payment schedules.

      '
    items:
      $ref: '#/definitions/PaymentScheduleCommonResponse'
    type: array
  PUTPaymentScheduleRequest:
    allOf:
    - properties:
        amount:
          description: 'Indicates the updated amount of the pending payment schedule items.

            '
          type: number
        currency:
          description: "Indicates the updated currency of the pending payment schedule items.      \n"
          type: string
        occurrences:
          description: "Indicates the updated number of payment schedule items that are created by the payment schedule.\n\n**Note:**\n  - If \"updated `occurrences` > existing `occurrences`\", the following number of pending payment schedule item will be added to the payment schedule: “updated `occurrences` - existing `occurrences`”.\n  - If \"existing `occurrences` > updated `occurrences` >= the number of `processed`/`errored`/`canceled` payment schedule items\", the following number of pending items will be removed by descending order of the schedule dates: \"existing `occurrences` - updated `occurrences`\".\n  - If \"updated `occurrences` < the number of `processed`/`erroed`/`canceled` payment schedule items\", a validation error will be returned.\n"
          type: integer
        paymentGatewayId:
          description: 'Indicates the updated payment gateway ID of the pending payment schedule items.

            '
          type: string
        paymentMethodId:
          description: "Indicates the updated payment method ID of the pending payment schedule items. \n"
          type: string
        paymentOption:
          description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n\n **Note:** To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/).\n"
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        period:
          description: 'Indicates the updated period of the pending payment schedule items.

            '
          enum:
          - Monthly
          - Weekly
          - BiWeekly
          type: string
        periodStartDate:
          description: 'Indicates the updated collection date for the next pending payment schedule item.

            '
          format: date
          type: string
        runHour:
          description: "Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.\n  \nIf the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
          format: date
          type: integer
      type: object
    - $ref: '#/definitions/PaymentScheduleCustomFields'
  PaymentRunStatistic:
    description: Payment run statistic.
    properties:
      completedOn:
        description: 'The date and time the payment run is completed.

          '
        format: date-time
        type: string
      executedOn:
        description: 'The date and time the payment run is executed.

          '
        format: date-time
        type: string
      number:
        description: 'Payment run number.

          '
        type: string
      numberOfErrors:
        description: 'Number of errored payments

          '
        type: integer
      numberOfPayments:
        description: 'Number of processed payments.

          '
        type: integer
      status:
        description: 'Payment run status.

          '
        type: string
    type: object
  PUTPaymentScheduleItemRequest:
    allOf:
    - properties:
        amount:
          description: 'The amount of the payment.

            '
          format: decimal
          type: number
        currency:
          description: 'The currency of the payment.

            '
          type: string
        description:
          description: 'The description of the payment schedule item.

            '
          type: string
        linkPayments:
          description: 'Container for payments linked to the payment schedule item.

            '
          items:
            $ref: '#/definitions/LinkedPaymentID'
          type: array
        paymentGatewayId:
          description: 'ID of the payment gateway of the payment schedule item.

            '
          type: string
        paymentId:
          description: 'ID of the payment to be linked to the payment schedule item.


            **Note**: This feild is version controlled. To enable this field, you must set `zuora-version` to equal or smaller than `336.0`.

            '
          type: string
        paymentMethodId:
          description: 'ID of the payment method of the payment schedule item.

            '
          type: string
        paymentOption:
          description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        runHour:
          description: 'At which hour of the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.

            '
          type: integer
        scheduledDate:
          description: 'The scheduled date when the payment is processed.

            '
          format: date
          type: string
        unlinkPayments:
          description: 'Container for payments to be unlinked from the payment schedule item.

            '
          items:
            $ref: '#/definitions/LinkedPaymentID'
          type: array
      type: object
    - $ref: '#/definitions/PaymentScheduleItemCustomFields'
  PaymentScheduleItemCommonResponse:
    allOf:
    - properties:
        accountId:
          description: 'ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.

            '
          type: string
        amount:
          description: 'The total amount of the payment schedule.

            '
          format: decimal
          type: number
        balance:
          description: 'The remaining balance of payment schedule item.

            '
          format: decimal
          type: number
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'Number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        createdById:
          description: 'The ID of the user who created the payment schedule item.

            '
          type: string
        createdDate:
          description: 'The date and time when the payment schedule item was created.

            '
          format: date
          type: string
        currency:
          description: 'The currency of the payment.

            '
          type: string
        description:
          description: 'The description of the payment schedule item.

            '
          type: string
        errorMessage:
          description: 'The error message indicating if the error is related to configuration or payment collection.

            '
          type: string
        id:
          description: 'ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.

            '
          type: string
        number:
          description: 'Number of the payment schedule item.

            '
          type: string
        paymentGatewayId:
          description: 'ID of the payment gateway of the payment schedule item.

            '
          type: string
        paymentId:
          description: "ID of the payment that is created by the payment schedule item， or ID of the first payment linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
          type: string
        paymentMethodId:
          description: 'ID of the payment method of the payment schedule item.

            '
          type: string
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleId:
          description: 'ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.

            '
          type: string
        paymentScheduleNumber:
          description: 'Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.

            '
          type: string
        psiPayments:
          description: "Container for payments linked to the payment schedule item. \n"
          items:
            $ref: '#/definitions/LinkedPaymentID'
          type: array
        runHour:
          description: 'At which hour in the day in the tenant’s timezone this payment will be collected.

            '
          type: integer
        scheduledDate:
          description: 'The scheduled date when the payment is processed.

            '
          format: date
          type: string
        standalone:
          description: 'Indicates if the payment created by the payment schedule item is a standalone payment or not.

            '
          type: boolean
        status:
          description: 'ID of the payment method of the payment schedule item.


            - `Pending`: Payment schedule item is waiting for processing.

            - `Processed`: The payment has been collected.

            - `Error`: Failed to collect the payment.

            - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.

            '
          enum:
          - Pending
          - Processed
          - Error
          - Canceled
          type: string
        updatedById:
          description: 'The ID of the user who updated the payment schedule item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment schedule item was last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleItemCustomFields'
  POSTRetryPaymentScheduleItemResponse:
    properties:
      items:
        items:
          $ref: '#/definitions/PaymentScheduleItemCommonResponse'
        type: array
      success:
        description: "Returns `true` if the request was processed successfully. \n"
        type: boolean
    type: object
  PaymentScheduleCustomFields:
    additionalProperties:
      description: 'Custom fields of the Payment Schedule object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case-sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.


        **Note:**

        The values will automatically be pushed to payment schedule items level if the same fields exist at the payment schedule item level.

        '
    description: 'Container for custom fields of a Payment Schedule object.

      '
    title: paymentScheduleFieldsCustom
    type: object
  POSTPaymentScheduleRequest:
    allOf:
    - properties:
        accountId:
          description: "ID of the customer account the payment schedule belongs to.\n\n**Note:**\n`accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other.          \n"
          type: string
        accountNumber:
          description: "Account number of the customer account the payment schedule belongs to.\n\n**Note:**\n`accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other.          \n"
          type: string
        amount:
          description: "The amount of each payment schedule item in the payment schedule.\n\n**Note:**\n- This field is required when `items` is not specified.\n- This field will be ignored when `items` is specified.\n- When creating recurring payment schedules, there are 2 options to specify amounts:  \n  - Specify `totalAmount` and `occurrences`, `amount` will be calculated.\n  - Specify `amount` and `occurrences`, `totalAmount` will be calculated.\n  You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.\n"
          type: number
        billingDocument:
          description: 'Object of the billing document with which the payment schedule is associated.


            **Note:**

            - This field is optional. If you have the Standalone Payment feature enabled, you can leave this field blank and set `standalone` to `true` to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting `standalone` to `false`.

            - If Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments.

            '
          properties:
            id:
              description: "ID of the billing document.\n\n**Note:**\n If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both.\n"
              type: string
            number:
              description: "ID of the billing document.\n\n**Note:**\n If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both.\n"
              type: string
            type:
              description: 'The type of the billing document. The default value is `Invoice`.

                '
              enum:
              - Invoice
              - DebitMemo
              type: string
          required:
          - type
          type: object
        currency:
          description: 'Currency of the payment schedule.


            **Note:**

            - This field is optional. The default value is the account''s default currency.

            - This field will be ignored when `items` is specified.

            '
          type: string
        description:
          description: 'Description of the payment schedule. Max length is 255.

            '
          type: string
        items:
          description: 'Container array for payment schedule items.

            '
          items:
            allOf:
            - properties:
                amount:
                  description: 'The amount that needs to be collected by this payment schedule item.

                    '
                  type: number
                billingDocument:
                  description: "Object for the billing document with which the payment schedule item is associated. \n**Note:** You must specify the same billing document for all the payment schedule items in one payment schedule.\n"
                  properties:
                    id:
                      description: 'The ID of the billing document.


                        **Note:**

                        If a billing document is specified, one of `id` or `number` must be specified. You cannot specify both of them or or skip both.

                        '
                      type: string
                    number:
                      description: 'The number of the billing document.


                        **Note:**

                        If a billing document is specified, one of `id` or `number` must be specified. You cannot specify both of them or skip both.

                        '
                      type: string
                    type:
                      description: 'The type of the billing document. The default value is `Invoice`.

                        '
                      enum:
                      - Invoice
                      - DebitMemo
                      type: string
                  required:
                  - type
                  type: object
                currency:
                  description: 'The currency of the payment.


                    **Note**:

                    - This field is optional. If not specified, the default value is the currency set for the account.

                    '
                  type: string
                description:
                  description: 'Description of the payment schedule item.

                    '
                  type: string
                paymentGatewayId:
                  description: 'The ID of the payment gateway.


                    **Note**:

                    - This field is optional. If not specified, the default value is the payment gateway id set for the account.

                    '
                  type: string
                paymentMethodId:
                  description: 'The ID of the payment method.


                    **Note**:

                    - This field is optional. If not specified, the default value is the payment method id set for the account.

                    '
                  type: string
                paymentOption:
                  description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n\nTo enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
                  items:
                    $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
                  type: array
                runHour:
                  description: 'At which hour in the day in the tenant’s timezone this payment will be collected. Available values:`[0,1,2,~,22,23]`. If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time.

                    The default value is `0`.

                    If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.

                    '
                  type: string
                scheduledDate:
                  description: 'The date to collect the payment.

                    '
                  format: date
                  type: string
              type: object
            - $ref: '#/definitions/PaymentScheduleItemCustomFields'
          type: array
        occurrences:
          description: "The number of payment schedule item to be created. Maximum value is 1000.\n\n**Note:**\n- This field is required when `items` is not specified.\n- This field will be ignored when `items` is specified. \n"
          type: integer
        paymentGatewayId:
          description: 'ID of the payment gateway.


            **Note:**

            - This field is optional. The default value is the account''s default payment gateway ID. If no payment gateway ID is found on the cusotmer account level, the default value will be the tenant''s default payment gateway ID.

            - This field will be ignored when `items` is specified.

            '
          type: string
        paymentMethodId:
          description: "ID of the payment method.\n\n**Note:**\n- This field is optional. The default value is the account's default payment method ID.\n- This field will be ignored when `items` is specified.  \n"
          type: string
        paymentOption:
          description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleNumber:
          description: "You can use this field to specify the number of the payment schedule.\nOnly characters from the following sets are allowed: A-Z, a-z, 0-9, and `-`. \nPayment numbers must start with a letter. In addition,`-` can only be used at most once and cannot be placed at the beginning or the end of the payment numbers.         \n"
          type: string
        period:
          description: "The frequency for the payment collection since the `startDate`.\n\n**Note:**\n- Thie field is required when `items` is not specified.\n- This field will be ignored when `items` is specified.\n- If `startDate` is `30` or `31` and `period` is `Monthly`, when in February, payment schedule will use the last day of February for payment collection. \n"
          enum:
          - Monthly
          - Weekly
          - BiWeekly
          type: string
        prepayment:
          description: 'Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        runHour:
          description: "Specifies at which hour in the day in the tenant’s time zone when this payment will be collected. Available values: `[0,1,2,~,22,23]`.\n\n**Note:**\n- If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time.\n- If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n- This field is optional. The default value is `0`.\n- This field will be ignored when `items` is specified.             \n"
          type: integer
        standalone:
          description: "Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to `null`, standalone payment will be created.\n\n**Note**: \n- This field is only available if the Standalone Payment is enabled. Do not include this field if Standalone Payment is not enabled.\n- If Standalone Payment is enabled, default value is `true`.\n"
          type: boolean
        startDate:
          description: "The date for the first payment collection.\n\n**Note:**\n- This field is required when `items` is not specified.\n- This field will be ignored when `items` is specified.              \n"
          format: date
          type: string
        totalAmount:
          description: "The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules. \n\n**Note**:\n- When creating recurring payment schedules, there are 2 options to specify amounts:\n  \n  - Specify `totalAmount` and `occurrences`, `amount` will be calculated.\n  - Specify `amount` and `occurrences`, `totalAmount` will be calculated.\n  \n  You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.\n- If the Standalone Payments feature is enabled and `standalone` is set to `true` for the payment schedule, `totalAmount` will be ignored.\n"
          type: number
      type: object
    - $ref: '#/definitions/PaymentScheduleCustomFields'
  PaymentScheduleCommonResponse:
    allOf:
    - properties:
        accountId:
          description: 'ID of the account that owns the payment schedule.

            '
          type: string
        accountNumber:
          description: 'Number of the account that owns the payment schedule.

            '
          type: string
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'The number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        createdById:
          description: 'The ID of the user who created this payment schedule.

            '
          type: string
        createdDate:
          description: 'The date and time the payment schedule is created.

            '
          format: date
          type: string
        description:
          description: 'The description of the payment schedule.

            '
          type: string
        id:
          description: 'ID of the payment schedule.

            '
          type: string
        isCustom:
          description: 'Indicates if the payment schedule is a custom payment schedule.

            '
          type: boolean
        items:
          description: 'Container for payment schedule items.

            '
          items:
            $ref: '#/definitions/PaymentScheduleItemCommonResponse'
          type: array
        nextPaymentDate:
          description: 'The date the next payment will be processed.

            '
          format: date
          type: string
        occurrences:
          description: 'The number of payment schedule items that are created by this payment schedule.

            '
          type: integer
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleNumber:
          description: 'Number of the payment schedule.

            '
          type: string
        period:
          description: 'For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.

            Returns `null` for custom payment schedules.

            '
          type: string
        prepayment:
          description: 'Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        recentPaymentDate:
          description: 'The date the last payment was processed.

            '
          format: date
          type: string
        runHour:
          description: '[0,1,2,~,22,23]


            At which hour in the day in the tenant’s timezone the recurring payment schedule items will be collected.

            Return `0` for custom payment schedules.

            '
          type: integer
        standalone:
          description: 'Indicates if the payments that the payment schedule created are standalone payments or not.

            '
          type: boolean
        startDate:
          description: 'The date when the first payment of this payment schedule is proccessed.

            '
          format: date
          type: string
        status:
          description: 'The status of the payment schedule.


            - Active: There is still payment schedule item to process.

            - Canceled: After a payment schedule is canceled by the user, the schedule is marked as `canceled`.

            - Completed: After all payment schedule items are processed, the schedule is marked as `Completed`.

            '
          enum:
          - Active
          - Canceled
          - Completed
          type: string
        totalAmount:
          description: "The total amount that will be collected by the payment schedule.            \n"
          type: number
        totalPaymentsErrored:
          description: 'The number of errored payments.

            '
          type: integer
        totalPaymentsProcessed:
          description: 'The number of processed payments.

            '
          type: integer
        updatedById:
          description: 'The ID of the user who last updated this payment schedule.

            '
          type: string
        updatedDate:
          description: 'The date and time the payment schedule is last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleCustomFields'
  LinkedPaymentID:
    properties:
      paymentId:
        description: 'ID of the payment.

          '
        type: string
    title: PaymentID
    type: object
  POSTRetryPaymentScheduleItemRequest:
    properties:
      items:
        description: 'The maximum number of items allowable to pass is 10.

          '
        items:
          $ref: '#/definitions/POSTRetryPaymentScheduleItemInfo'
        title: Payment schedule items to be retried.
        type: array
    type: object
  POSTPaymentSchedulesRequest:
    properties:
      paymentSchedules:
        description: 'Container of the payment schedules to be created.

          '
        items:
          $ref: '#/definitions/POSTPaymentScheduleRequest'
        type: array
    type: object
  PUTPaymentScheduleItemResponse:
    allOf:
    - properties:
        accountId:
          description: 'ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.

            '
          type: string
        amount:
          description: 'The amount of the payment schedule item.

            '
          format: decimal
          type: number
        balance:
          description: "The remaining balance of payment schedule item.         \n"
          format: decimal
          type: number
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'The number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        cancellationReason:
          description: "The reason for the cancellation of payment schedule item.  \n"
          type: string
        createdById:
          description: 'The ID of the user who created the payment schedule item.

            '
          type: string
        createdDate:
          description: 'The date and time when the payment schedule item was created.

            '
          format: date
          type: string
        currency:
          description: 'The currency of the payment.

            '
          type: string
        description:
          description: 'The description of the payment schedule item.

            '
          type: string
        errorMessage:
          description: 'The error message indicating if the error is related to the configuration or the payment collection.

            '
          type: string
        id:
          description: 'ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.

            '
          type: string
        number:
          description: 'Number of the payment schedule item.

            '
          type: string
        paymentGatewayId:
          description: 'ID of the payment gateway of the payment schedule item.

            '
          type: string
        paymentId:
          description: "ID of the payment that is created by the payment schedule item, or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
          type: string
        paymentMethodId:
          description: 'ID of the payment method of the payment schedule item.

            '
          type: string
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleId:
          description: 'ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,

            '
          type: string
        paymentScheduleNumber:
          description: 'Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,

            '
          type: string
        psiPayments:
          description: 'Container for payments linked to the payment schedule item.

            '
          items:
            $ref: '#/definitions/LinkedPaymentID'
          type: array
        runHour:
          description: 'At which hour in the day in the tenant’s timezone this payment will be collected.

            '
          type: integer
        scheduledDate:
          description: 'The scheduled date when the payment is processed.

            '
          format: date
          type: string
        standalone:
          description: 'Indicates if the payment created by the payment schedule item is a standalone payment.

            '
          type: boolean
        status:
          description: 'ID of the payment method of the payment schedule item.


            - `Pending`: Waiting for processing.

            - `Processed`: The payment has been collected.

            - `Error`: Failed to collect the payment.

            - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.

            '
          enum:
          - Pending
          - Processed
          - Error
          - Canceled
          type: string
        success:
          description: "Returns `true` if the request was processed successfully. \n"
          type: boolean
        updatedById:
          description: 'The ID of the user who updated the payment schedule item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment schedule item was last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleItemCustomFields'
  PaymentScheduleItemCommon:
    allOf:
    - properties:
        amount:
          description: 'The amount that needs to be collected by this payment schedule item.

            '
          type: number
        currency:
          description: 'The currency of the payment.


            **Note**:

            - This field is optional. If not specified, the default value is the currency set for the account.

            '
          type: string
        description:
          description: 'Description of the payment schedule item.

            '
          type: string
        paymentGatewayId:
          description: 'The ID of the payment gateway.


            **Note**:

            - This field is optional. If not specified, the default value is the payment gateway id set for the account.

            '
          required:
          - type
          type: string
        paymentMethodId:
          description: 'The ID of the payment method.


            **Note**:

            - This field is optional. If not specified, the default value is the payment method id set for the account.

            '
          type: string
        paymentOption:
          description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        runHour:
          description: 'At which hour of the day in the tenant’s timezone this payment will be collected. Available values:`[0,1,2,~,22,23]`.

            If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.

            The default value is `0`.

            '
          type: string
        scheduledDate:
          description: 'The date to collect the payment.

            '
          format: date
          type: string
      required:
      - scheduledDate
      - amount
      type: object
    - $ref: '#/definitions/PaymentScheduleItemCustomFields'
  PUTCancelPaymentScheduleRequest:
    properties:
      cancelDate:
        description: 'Specifies when the payment schedule will be canceled.

          '
        format: date
        type: string
    required:
    - cancelDate
    type: object
  PUTPreviewPaymentScheduleRequest:
    allOf:
    - properties:
        amount:
          description: 'Indicates the updated amount of the pending payment schedule items.

            '
          type: number
        currency:
          description: "Indicates the updated currency of the pending payment schedule items.      \n"
          type: string
        occurrences:
          description: 'Indicates the updated number of payment schedule items that are created by the payment schedule.

            '
          type: integer
        paymentGatewayId:
          description: 'Indicates the updated payment gateway ID of the pending payment schedule items.

            '
          type: string
        paymentMethodId:
          description: "Indicates the updated payment method ID of the pending payment schedule items. \n"
          type: string
        paymentOption:
          description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        period:
          description: 'Indicates the updated period of the pending payment schedule items.

            '
          enum:
          - Monthly
          - Weekly
          - BiWeekly
          type: string
        periodStartDate:
          description: 'Indicates the updated collection date for the next pending payment schedule item.

            '
          format: date
          type: string
        runHour:
          description: "Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.\n  \nIf the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
          format: date
          type: integer
      type: object
    - $ref: '#/definitions/PaymentScheduleCustomFields'
  POSTPaymentSchedulesEach:
    properties:
      id:
        description: 'The ID of the created payment schedule.

          '
        type: string
      paymentScheduleNumber:
        description: 'The number of the created payment schedule.

          '
        type: string
    title: Payment Schedule ID and Number
    type: object
  GETPaymentScheduleStatisticResponse:
    description: 'The object that contains the payment schedule statistic of the specified date.

      '
    properties:
      date:
        description: 'The specified date.

          '
        format: date
        type: string
      paymentRuns:
        items:
          $ref: '#/definitions/PaymentRunStatistic'
        title: PaymentRunStatistic
        type: array
      paymentScheduleItems:
        properties:
          error:
            description: "The number of errored payment schedule items.              \n"
            type: integer
          pending:
            description: 'The number of pending payment schedule items.

              '
            type: integer
          processed:
            description: "The number of processed payment schedule items. \n"
            type: integer
        type: object
      success:
        description: 'Returns `true` if the request was processed successfully.

          '
        type: boolean
    type: object
  POSTAddItemsToPaymentScheduleRequest:
    description: 'Container for the payment schedule items to be added to the payment schedule.

      '
    properties:
      items:
        items:
          $ref: '#/definitions/PaymentScheduleItemCommon'
        title: paymentScheduleItem
        type: array
    type: object
  PaymentScheduleItemCustomFields:
    additionalProperties:
      description: 'Custom fields of the Payment Schedule Item object. The name of each custom field has the form <code>*customField*__c</code>. 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 Schedule Item object.

      '
    title: paymentScheduleItemFieldsCustom
    type: object
  GETPaymentScheduleItemResponse:
    allOf:
    - properties:
        accountId:
          description: 'ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.

            '
          type: string
        amount:
          description: 'The total amount of the payment schedule item.

            '
          format: decimal
          type: number
        balance:
          description: 'The remaining balance of payment schedule item.

            '
          format: decimal
          type: number
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'The number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        cancellationReason:
          description: "The reason for the cancellation of payment schedule item.  \n"
          type: string
        createdById:
          description: 'The ID of the user who created the payment schedule item.

            '
          type: string
        createdDate:
          description: 'The date and time when the payment schedule item was created.

            '
          format: date
          type: string
        currency:
          description: 'The currency of the payment.

            '
          type: string
        description:
          description: 'The description of the payment schedule item.

            '
          type: string
        errorMessage:
          description: 'The error message indicating if the error is related to the configuration or the payment collection.

            '
          type: string
        id:
          description: 'ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.

            '
          type: string
        number:
          description: 'Number of the payment schedule item.

            '
          type: string
        paymentGatewayId:
          description: 'ID of the payment gateway of the payment schedule item.

            '
          type: string
        paymentId:
          description: "ID of the payment that is created by the payment schedule item， or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
          type: string
        paymentMethodId:
          description: 'ID of the payment method of the payment schedule item.

            '
          type: string
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleId:
          description: 'ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,

            '
          type: string
        paymentScheduleNumber:
          description: 'Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,

            '
          type: string
        psiPayments:
          description: "Container for payments linked to the payment schedule item. \n"
          items:
            $ref: '#/definitions/LinkedPaymentID'
          type: array
        runHour:
          description: 'At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.

            '
          type: integer
        scheduledDate:
          description: 'The scheduled date when the payment is processed.

            '
          format: date
          type: string
        standalone:
          description: 'Indicates if the payment created by the payment schedule item is a standalone payment.

            '
          type: boolean
        status:
          description: 'ID of the payment method of the payment schedule item.


            - `Pending`: Waiting for processing.

            - `Processed`: The payment has been collected.

            - `Error`: Failed to collect the payment.

            - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.

            '
          enum:
          - Pending
          - Processed
          - Error
          - Canceled
          type: string
        success:
          description: "Returns `true` if the request was processed successfully. \n"
          type: boolean
        updatedById:
          description: 'The ID of the user who updated the payment schedule item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment schedule item was last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleItemCustomFields'
  POSTPaymentSchedulesResponse:
    description: 'Container of the payment schedules that are created.

      '
    properties:
      paymentSchedules:
        description: 'Container for payment parts.

          '
        items:
          $ref: '#/definitions/POSTPaymentSchedulesEach'
        type: array
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  PaymentSchedulePaymentOptionFields:
    properties:
      detail:
        description: 'The field used to pass the transactional payment data to the gateway side in the key-value format.

          '
        properties:
          key:
            description: 'The name of the field.

              '
            type: string
          value:
            description: 'The value of the field.

              '
            type: string
        type: object
      type:
        description: 'The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway.

          '
        type: string
    title: paymentOption
    type: object
  POSTPaymentScheduleResponse:
    allOf:
    - properties:
        accountId:
          description: 'ID of the account that owns the payment schedule.

            '
          type: string
        accountNumber:
          description: 'Number of the account that owns the payment schedule.

            '
          type: string
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'Number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        createdById:
          description: 'ID of the user who created this payment schedule.

            '
          type: string
        createdDate:
          description: 'The date and time the payment schedule is created.

            '
          format: date
          type: string
        description:
          description: 'The description of the payment schedule.

            '
          type: string
        id:
          description: 'ID of the payment schedule.

            '
          type: string
        isCustom:
          description: 'Indicates if the payment schedule is a custom payment schedule.

            '
          type: boolean
        items:
          description: 'Container for payment schedule items.

            '
          items:
            $ref: '#/definitions/PaymentScheduleItemCommonResponse'
          type: array
        nextPaymentDate:
          description: 'The date the next payment will be processed.

            '
          format: date
          type: string
        occurrences:
          description: 'The number of payment schedule items that are created by this payment schedule.

            '
          type: integer
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleNumber:
          description: 'Number of the payment schedule.

            '
          type: string
        period:
          description: 'For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.

            Return `null` for custom payment schedules.

            '
          type: string
        prepayment:
          description: 'Indicates whether the payments created by the payment schedule are used as a reserved payment. This field will only be available if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        recentPaymentDate:
          description: 'The date the last payment was processed.

            '
          format: date
          type: string
        runHour:
          description: '[0,1,2,~,22,23]


            At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.

            Return `0` for custom payment schedules.

            '
          type: integer
        standalone:
          description: 'Indicates if the payments that the payment schedule created are standalone payments or not.

            '
          type: boolean
        startDate:
          description: 'The date when the first payment of this payment schedule is proccessed.

            '
          format: date
          type: string
        status:
          description: 'The status of the payment schedule.


            - `Active`: There are still pament schedule items to process.

            - `Canceled`: After a payment schedule is canceled by the user, the schedule is marked as `Canceled`.

            - `Completed`: After all payment schedule items are processed, the schedule is marked as `Completed`.

            '
          enum:
          - Active
          - Canceled
          - Completed
          type: string
        success:
          description: "Returns `true` if the request was processed successfully.        \n"
          type: boolean
        totalAmount:
          description: 'The total amount that will be collected by this payment schedule. This field will contain a null value if the `standalone` value is `true`.

            '
          type: number
        totalPaymentsErrored:
          description: 'The number of errored payments.

            '
          type: integer
        totalPaymentsProcessed:
          description: 'The number of processed payments.

            '
          type: integer
        updatedById:
          description: 'ID of the user who last updated this payment schedule.

            '
          type: string
        updatedDate:
          description: 'The date and time the payment schedule is last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleCustomFields'
  PUTSkipPaymentScheduleItemResponse:
    allOf:
    - properties:
        amount:
          description: 'The amount of the payment.

            '
          format: decimal
          type: number
        billingDocument:
          properties:
            id:
              description: 'ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.

                '
              type: string
            number:
              description: 'The number of the billing docuemnt, for example, `INV00002345`.

                '
              type: string
            type:
              description: 'Indicates whether the associated billing document is a debit memo or a invoice.

                '
              type: string
          type: object
        cancellationReason:
          description: "The reason for the cancellation of payment schedule item.            \n"
          type: string
        createdById:
          description: 'The ID of the user who created the payment schedule item.

            '
          type: string
        createdDate:
          description: 'The date and time when the payment schedule item was created.

            '
          format: date
          type: string
        currency:
          description: 'The currency of the payment.

            '
          type: string
        description:
          description: 'The description of the payment schedule item.

            '
          type: string
        errorMessage:
          description: 'The error message indicating if the error is related to the configuration or the payment collection.

            '
          type: string
        id:
          description: 'ID of the newly-created payment schedule item. For example, `412880e749b72b310149b7343ef81346`.

            '
          type: string
        number:
          description: 'Number of the newly-created payment schedule item.

            '
          type: string
        paymentGatewayId:
          description: 'ID of the payment gateway of the payment schedule item.

            '
          type: string
        paymentId:
          description: "ID of the payment that is created by the payment schedule item， or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`.  \n"
          type: string
        paymentMethodId:
          description: 'ID of the payment method of the payment schedule item.

            '
          type: string
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleId:
          description: 'ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,

            '
          type: string
        paymentScheduleNumber:
          description: "Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n     \n"
          type: string
        psiPayments:
          description: "Container for payments linked to the payment schedule item. \n"
          items:
            $ref: '#/definitions/LinkedPaymentID'
          type: array
        runHour:
          description: 'At which hour in the day in the tenant’s timezone this payment will be collected.

            '
          type: integer
        scheduledDate:
          description: 'The scheduled date when the payment is processed.

            '
          format: date
          type: string
        standalone:
          description: 'Indicates if the payment created by the payment schedule item is a standalone payment.

            '
          type: boolean
        status:
          description: 'ID of the payment method of the payment schedule item.


            - `Pending`: Waiting for processing.

            - `Processed`: The payment has been collected.

            - `Error`: Failed to collect the payment.

            - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.

            '
          enum:
          - Pending
          - Processed
          - Error
          - Canceled
          type: string
        success:
          description: "Returns `true` if the request was processed successfully. \n"
          type: boolean
        updatedById:
          description: 'The ID of the user who updated the payment schedule item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment schedule item was last updated.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/PaymentScheduleItemCustomFields'
  POSTRetryPaymentScheduleItemInfo:
    description: 'Information of the payment schedule items to be retried.

      '
    properties:
      id:
        description: 'Specifies the ID of the payment schedule item to be retried.

          '
        type: string
      paymentGatewayId:
        description: 'Specifies the ID of a payment gateway that will be used in the retry.

          '
        type: string
      paymentMethodId:
        description: 'Specifies the ID of a payment method that will be used in the retry.

          '
        type: string
    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_HEADER_Zuora_Org_Ids:
    name: Zuora-Org-Ids
    in: header
    required: false
    type: string
    description: "Comma separated IDs. If you have <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Multi-Org\" target=\"_blank\">Zuora Multi-Org</a> 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_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_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_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_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